NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.DisplayableObject Class Reference

Base class for all objects that are displayable. More...

Inheritance diagram for NXOpen.DisplayableObject:
NXOpen.NXObject NXOpen.IFitTo NXOpen.INXObject NXOpen.INXObject NXOpen.Annotations.Annotation NXOpen.Annotations.Table NXOpen.Assemblies.Component NXOpen.Body NXOpen.CAE.CAEBody NXOpen.CAE.CAEConnection NXOpen.CAE.CaeDOFSet NXOpen.CAE.CAEEdge NXOpen.CAE.CAEFace NXOpen.CAE.CAEVertex NXOpen.CAE.Connections.IConnection NXOpen.CAE.Mesh NXOpen.CAE.MeshControl NXOpen.CAE.ResponseSimulation.Sensor NXOpen.CAE.ResponseSimulation.StrainGage NXOpen.CAE.SelectionRecipe NXOpen.CAE.SimBC NXOpen.DatumAxis NXOpen.DatumPlane NXOpen.Diagramming.BaseObject NXOpen.Display.EntitySelectionPlane NXOpen.Display.Grid NXOpen.Display.ImageBase NXOpen.Display.PointCloud NXOpen.Drawings.DraftingBody NXOpen.Drawings.DraftingCurve NXOpen.Drawings.DrawingRegion NXOpen.Drawings.SectionLine NXOpen.Edge NXOpen.Face NXOpen.Facet.FacetedBody NXOpen.Facet.FacetedEdge NXOpen.Facet.FacetedFace NXOpen.Fields.Field NXOpen.GeometricAnalysis.AnalysisObject NXOpen.Group NXOpen.Layout2d.Component NXOpen.LineDesigner.CreateFactoryElement NXOpen.LineDesigner.CreateFence NXOpen.LineDesigner.CreateSystem NXOpen.LineDesigner.ExportToDWG NXOpen.Mechatronics.Accelerometer NXOpen.Mechatronics.AdapterSignal NXOpen.Mechatronics.CollisionBody NXOpen.Mechatronics.CollisionSensor NXOpen.Mechatronics.DisplayChanger NXOpen.Mechatronics.DistanceSensor NXOpen.Mechatronics.ExternalConnection NXOpen.Mechatronics.GenericSensor NXOpen.Mechatronics.GraphControl NXOpen.Mechatronics.HydraulicCylinder NXOpen.Mechatronics.HydraulicValve NXOpen.Mechatronics.Inclinometer NXOpen.Mechatronics.LimitSwitch NXOpen.Mechatronics.MATLABSignalConnection NXOpen.Mechatronics.ObjectSink NXOpen.Mechatronics.ObjectSource NXOpen.Mechatronics.ObjectTransformer NXOpen.Mechatronics.PhysicsConstraint NXOpen.Mechatronics.PhysicsJoint NXOpen.Mechatronics.PneumaticCylinder NXOpen.Mechatronics.PneumaticValve NXOpen.Mechatronics.PositionSensor NXOpen.Mechatronics.ProxyObject NXOpen.Mechatronics.Relay NXOpen.Mechatronics.RigidBody NXOpen.Mechatronics.SHMSignalConnection NXOpen.Mechatronics.SignalAdapter NXOpen.Mechatronics.SignalConnection NXOpen.Mechatronics.SignalMappingConnection NXOpen.Mechatronics.Tracer NXOpen.Mechatronics.VelocitySensor NXOpen.Mechatronics.VirtualAxis NXOpen.Mfg.Mlp.Blank NXOpen.Mfg.Mlp.InProcessFeature NXOpen.Mfg.Mlp.Line NXOpen.Mfg.Mlp.MachineTool NXOpen.Mfg.Mlp.MachiningFeature NXOpen.Mfg.Mlp.Operation NXOpen.Mfg.Mlp.Part NXOpen.Mfg.Mlp.PartFeature NXOpen.Mfg.Mlp.ProcessPlan NXOpen.Mfg.Mlp.ProcessSetup NXOpen.Mfg.Mlp.Product NXOpen.Mfg.Mlp.ToolAssembly NXOpen.Mfg.Mlp.ToolSet NXOpen.Mfg.Mlp.Workpiece NXOpen.Motion.Marker NXOpen.Motion.MotionObject NXOpen.Motion.SubmechanismPositioner NXOpen.Positioning.DisplayedConstraint NXOpen.ReferenceSet NXOpen.Routing.FormboardFrame NXOpen.ScCollector NXOpen.Section NXOpen.Sketch NXOpen.SketchConstraint NXOpen.SmartObject NXOpen.SubdivisionMeshBody NXOpen.SubdivisionMeshEdge NXOpen.SubdivisionMeshFace NXOpen.SubdivisionMeshVertex NXOpen.Traceline NXOpen.UserDefinedObjects.UserDefinedObject

Public Types

enum  ObjectWidth {
  Normal, Thick, Thin, One = 5,
  Two, Three, Four, Five,
  Six, Seven, Eight, Nine
}
 specifies object width for objects such as lines and text More...
 
enum  ObjectFont {
  Solid = 1, Dashed, Phantom, Centerline,
  Dotted, LongDashed, DottedDashed
}
 specifies the object font for objects such as lines More...
 
- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

unsafe void Blank ()
 Blanks the object. More...
 
unsafe void Unblank ()
 Unblanks the object. More...
 
unsafe void Highlight ()
 Highlights the object. More...
 
unsafe void Unhighlight ()
 Unhighlights the object. More...
 
unsafe void SetNameLocation (NXOpen.Point3d location)
 Sets the location of the object's name. More...
 
unsafe void RedisplayObject ()
 Redisplays the object in all views. More...
 
unsafe void RemoveViewDependency ()
 Remove dependency on all views from an object. More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 

Properties

unsafe int Color [get, set]
 Returns or sets the color of the object. More...
 
unsafe bool IsBlanked [get]
 Returns the blank status of this object. More...
 
unsafe int Layer [get, set]
 Returns or sets the layer that the object is in. More...
 
unsafe
NXOpen.DisplayableObject.ObjectFont 
LineFont [get, set]
 Returns or sets the line font of the object. More...
 
unsafe
NXOpen.DisplayableObject.ObjectWidth 
LineWidth [get, set]
 Returns or sets the line width of the object. More...
 
unsafe NXOpen.Point3d NameLocation [get]
 Returns the location of the object's name. More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Detailed Description

Base class for all objects that are displayable.

This is an abstract class, and cannot be instantiated.

Created in NX3.0.0

Member Enumeration Documentation

specifies the object font for objects such as lines

Enumerator
Solid 
Dashed 
Phantom 
Centerline 
Dotted 
LongDashed 
DottedDashed 

specifies object width for objects such as lines and text

Enumerator
Normal 
Thick 
Thin 
One 
Two 
Three 
Four 
Five 
Six 
Seven 
Eight 
Nine 

Member Function Documentation

unsafe void NXOpen.DisplayableObject.Blank ( )

Blanks the object.

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.DisplayableObject.Highlight ( )

Highlights the object.

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.DisplayableObject.RedisplayObject ( )

Redisplays the object in all views.

Typically this is used to display an object after its creation.

Created in NX4.0.0

License requirements: None.

unsafe void NXOpen.DisplayableObject.RemoveViewDependency ( )

Remove dependency on all views from an object.

Created in NX10.0.0

License requirements: None.

unsafe void NXOpen.DisplayableObject.SetNameLocation ( NXOpen.Point3d  location)

Sets the location of the object's name.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements: None.

Parameters
location
unsafe void NXOpen.DisplayableObject.Unblank ( )

Unblanks the object.

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.DisplayableObject.Unhighlight ( )

Unhighlights the object.

Created in NX3.0.0

License requirements: None.

Property Documentation

unsafe int NXOpen.DisplayableObject.Color
getset

Returns or sets the color of the object.

After setting the color, you must call RedisplayObject in order for the change to take effect. There is a more efficient way to change the color, layer, line font or line width of a object. First call NXOpen.DisplayManager.NewDisplayModification and then call any combination of set methods for the properties NXOpen.DisplayModification.NewColor , NXOpen.DisplayModification.NewWidth , NXOpen.DisplayModification.NewFont and NXOpen.DisplayModification.NewLayer . Finally call NXOpen.DisplayModification.Apply . This eliminates the need to call RedisplayObject .

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.DisplayableObject.IsBlanked
get

Returns the blank status of this object.

Created in NX3.0.0

License requirements: None.

unsafe int NXOpen.DisplayableObject.Layer
getset

Returns or sets the layer that the object is in.

After setting the layer, you must call RedisplayObject in order for the change to take effect, except see the comments for NXOpen.DisplayableObject.Color .

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.DisplayableObject.ObjectFont NXOpen.DisplayableObject.LineFont
getset

Returns or sets the line font of the object.

After setting the line font, you must call RedisplayObject in order for the change to take effect, except see the comments for NXOpen.DisplayableObject.Color .

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.DisplayableObject.ObjectWidth NXOpen.DisplayableObject.LineWidth
getset

Returns or sets the line width of the object.

After setting the line width, you must call RedisplayObject in order for the change to take effect, except see the comments for NXOpen.DisplayableObject.Color .

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point3d NXOpen.DisplayableObject.NameLocation
get

Returns the location of the object's name.

Created in NX3.0.0

License requirements: None.


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