NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.Annotations.BaseNote Class Reference

Represents a Note More...

Inheritance diagram for NXOpen.Annotations.BaseNote:
NXOpen.Annotations.NoteBase NXOpen.Annotations.IPmi NXOpen.Annotations.SimpleDraftingAid NXOpen.INXObject NXOpen.Annotations.DraftingAid NXOpen.Annotations.Annotation NXOpen.DisplayableObject NXOpen.NXObject NXOpen.IFitTo NXOpen.INXObject NXOpen.INXObject NXOpen.Annotations.GenericNote NXOpen.Annotations.Note NXOpen.Annotations.PmiNote NXOpen.Drawings.ViewingDirectionArrowLabel

Public Member Functions

unsafe void UpdateFromRule ()
 Updates the specified note from the KF rule. More...
 
unsafe
NXOpen.Annotations.BusinessModifier[] 
GetBusinessModifiers ()
 Returns the business modifiers More...
 
unsafe void SetBusinessModifiers (NXOpen.Annotations.BusinessModifier[] businessModifiers)
 Sets the business modifiers. More...
 
unsafe void AddBusinessModifiers (NXOpen.Annotations.BusinessModifier[] businessModifiers)
 Adds the business modifiers. More...
 
unsafe
NXOpen.Annotations.AssociatedObject 
GetAssociatedObject ()
 Returns the associated object More...
 
unsafe
NXOpen.Annotations.AssociatedObject 
GetSharedAssociatedObject ()
 Returns the shared associated objects More...
 
unsafe void SetAssociatedObject (NXOpen.Annotations.AssociatedObject assocObj)
 Sets the associated object. More...
 

Properties

unsafe bool IsVertical [get, set]
 Returns or sets a flag indicating whether the note is vertical. More...
 
unsafe int Index [get, set]
 Returns or sets the index. More...
 
unsafe bool IsMirrored [get]
 Returns a flag indicating whether the annotation is mirrored More...
 
- Properties inherited from NXOpen.Annotations.IPmi
int Index [get, set]
 Returns or sets the index. More...
 
bool IsMirrored [get]
 Returns a flag indicating whether the annotation is mirrored 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...
 

Additional Inherited Members

- Public Types inherited from NXOpen.DisplayableObject
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...
 

Detailed Description

Represents a Note

This is an abstract class and cannot be directly instantiated

Created in NX6.0.0

Member Function Documentation

unsafe void NXOpen.Annotations.BaseNote.AddBusinessModifiers ( NXOpen.Annotations.BusinessModifier[]  businessModifiers)

Adds the business modifiers.

Created in NX12.0.0

License requirements: geometric_tol ("GDT")

Parameters
businessModifiersList of new business modifiers

Implements NXOpen.Annotations.IPmi.

unsafe NXOpen.Annotations.AssociatedObject NXOpen.Annotations.BaseNote.GetAssociatedObject ( )

Returns the associated object

Created in NX4.0.0

License requirements: None.

Returns
Associated object

Implements NXOpen.Annotations.IPmi.

unsafe NXOpen.Annotations.BusinessModifier [] NXOpen.Annotations.BaseNote.GetBusinessModifiers ( )

Returns the business modifiers

Created in NX4.0.0

License requirements: None.

Returns
List of business modifiers

Implements NXOpen.Annotations.IPmi.

unsafe NXOpen.Annotations.AssociatedObject NXOpen.Annotations.BaseNote.GetSharedAssociatedObject ( )

Returns the shared associated objects

Created in NX8.5.0

License requirements: None.

Returns
Shared associated objects

Implements NXOpen.Annotations.IPmi.

unsafe void NXOpen.Annotations.BaseNote.SetAssociatedObject ( NXOpen.Annotations.AssociatedObject  assocObj)

Sets the associated object.

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 NX4.0.0

License requirements: geometric_tol ("GDT")

Parameters
assocObjNew associated object

Implements NXOpen.Annotations.IPmi.

unsafe void NXOpen.Annotations.BaseNote.SetBusinessModifiers ( NXOpen.Annotations.BusinessModifier[]  businessModifiers)

Sets the business modifiers.

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 NX4.0.0

License requirements: geometric_tol ("GDT")

Parameters
businessModifiersList of new business modifiers

Implements NXOpen.Annotations.IPmi.

unsafe void NXOpen.Annotations.BaseNote.UpdateFromRule ( )

Updates the specified note from the KF rule.

The changes are not applied till an update is performed by calling Update.DoUpdate .

Created in NX8.0.0

License requirements: drafting ("DRAFTING")

Property Documentation

unsafe int NXOpen.Annotations.BaseNote.Index
getset

Returns or sets the index.

It is a unique integer assigned to a PMI object.

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 NX4.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe bool NXOpen.Annotations.BaseNote.IsMirrored
get

Returns a flag indicating whether the annotation is mirrored

Created in NX8.5.0

License requirements: None.

unsafe bool NXOpen.Annotations.BaseNote.IsVertical
getset

Returns or sets a flag indicating whether the note is vertical.

When editing this, the changes are not applied to the system until an update is performed. An update can be performed by calling Update.DoUpdate .

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: drafting ("DRAFTING")


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