NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.CAE.NoteManager Class Reference

Represents an object that manages annotation for CAE More...

Inheritance diagram for NXOpen.CAE.NoteManager:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Member Functions

unsafe void AttachObjectsWithNote (NXOpen.TaggedObject note, NXOpen.TaggedObject[] objectArray)
 Attach objects with annotation More...
 
unsafe NXOpen.CAE.CaeNoteBuilder CreateCaeNoteBuilder (NXOpen.Annotations.SimpleDraftingAid annotation)
 Creates a builder for cae annotation command More...
 
unsafe NXOpen.CAE.CaeNote CreateNote (string[] lines, NXOpen.Point3d origin, int font, int fontColor, int fontSize, NXOpen.CAE.Plane planeType, string folderName)
 Create annotation with given settings More...
 
unsafe NXOpen.CAE.NoteFolder CreateNoteFolder (string folderName)
 Creates a folder for cae annotation More...
 
unsafe
NXOpen.CAE.NotePreferencesBuilder 
CreateNotePreferencesBuilder ()
 Creates a builder for note preferences command More...
 
unsafe void DeleteFolder (NXOpen.CAE.NoteFolder folder)
 Delete specified folder More...
 
unsafe void DetachObjectsWithNote (NXOpen.TaggedObject note)
 Detach objects with annotation More...
 
unsafe void FindNotesWithSubtext (string findStr, out NXOpen.TaggedObject[] noteArray)
 Gets all the annotations which contain the given text More...
 
unsafe void FindNotesWithText (string findStr, out NXOpen.TaggedObject[] noteArray)
 Gets all the annotations with a given text More...
 
unsafe void GetAllNotes (out NXOpen.TaggedObject[] noteArray)
 Gets all the annotations of a part More...
 
unsafe void GetAllNotesOfFolder (string folderName, out NXOpen.TaggedObject[] noteArray)
 Gets all the annotations of a folder More...
 
unsafe bool GetDisplayStatus (NXOpen.TaggedObject notes)
 Get display status of annotation More...
 
unsafe NXOpen.TaggedObject GetFolderOfAnnotation (NXOpen.Annotations.NoteBase annotation)
 Gets Folder of an existing annotation More...
 
unsafe void HideNotes (NXOpen.TaggedObject[] noteArray)
 Hide annotations More...
 
unsafe void MoveNotesToFolder (NXOpen.CAE.NoteFolder folder, NXOpen.Annotations.NoteBase[] annotation)
 Move notes to specified folder More...
 
unsafe void RenameFolder (NXOpen.CAE.NoteFolder folder, string folderName)
 Rename specified folder More...
 
unsafe void SetOrigin (NXOpen.TaggedObject note, NXOpen.Point3d origin)
 Move annotation to a new location More...
 
unsafe void SetParallelToScreen (bool parallelToScreen, NXOpen.CAE.CaeNote[] annotations)
 Sets the parallel to screen status on each input annotation. More...
 
unsafe void SetText (NXOpen.TaggedObject note, string[] lines)
 Set new text in annotation More...
 
unsafe void ShowNotes (NXOpen.TaggedObject[] noteArray)
 Display hidden annotations More...
 
NXOpen.CAE.NoteFolder[] ToArray ()
 Returns an array of NXOpen.CAE.NoteFolder objects. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. 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...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Represents an object that manages annotation for CAE

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

Created in NX12.0.0

Member Function Documentation

unsafe void NXOpen.CAE.NoteManager.AttachObjectsWithNote ( NXOpen.TaggedObject  note,
NXOpen.TaggedObject[]  objectArray 
)
inline

Attach objects with annotation

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
note
objectArrayArray of objects
unsafe NXOpen.CAE.CaeNoteBuilder NXOpen.CAE.NoteManager.CreateCaeNoteBuilder ( NXOpen.Annotations.SimpleDraftingAid  annotation)
inline

Creates a builder for cae annotation command

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
annotationNXOpen.Annotations.SimpleDraftingAid to be edited
Returns
unsafe NXOpen.CAE.CaeNote NXOpen.CAE.NoteManager.CreateNote ( string[]  lines,
NXOpen.Point3d  origin,
int  font,
int  fontColor,
int  fontSize,
NXOpen.CAE.Plane  planeType,
string  folderName 
)
inline

Create annotation with given settings

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
linesList of text
origin
font
fontColor
fontSize
planeType
folderName
Returns
unsafe NXOpen.CAE.NoteFolder NXOpen.CAE.NoteManager.CreateNoteFolder ( string  folderName)
inline

Creates a folder for cae annotation

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
folderName
Returns
unsafe NXOpen.CAE.NotePreferencesBuilder NXOpen.CAE.NoteManager.CreateNotePreferencesBuilder ( )
inline

Creates a builder for note preferences command

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe void NXOpen.CAE.NoteManager.DeleteFolder ( NXOpen.CAE.NoteFolder  folder)
inline

Delete specified folder

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
folder
unsafe void NXOpen.CAE.NoteManager.DetachObjectsWithNote ( NXOpen.TaggedObject  note)
inline

Detach objects with annotation

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
note
override int NXOpen.CAE.NoteManager.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe void NXOpen.CAE.NoteManager.FindNotesWithSubtext ( string  findStr,
out NXOpen.TaggedObject[]  noteArray 
)
inline

Gets all the annotations which contain the given text

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
findStr
noteArrayArray of annotations
unsafe void NXOpen.CAE.NoteManager.FindNotesWithText ( string  findStr,
out NXOpen.TaggedObject[]  noteArray 
)
inline

Gets all the annotations with a given text

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
findStr
noteArrayArray of annotations
unsafe void NXOpen.CAE.NoteManager.GetAllNotes ( out NXOpen.TaggedObject[]  noteArray)
inline

Gets all the annotations of a part

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
noteArrayArray of annotations
unsafe void NXOpen.CAE.NoteManager.GetAllNotesOfFolder ( string  folderName,
out NXOpen.TaggedObject[]  noteArray 
)
inline

Gets all the annotations of a folder

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
folderName
noteArrayArray of annotations
unsafe bool NXOpen.CAE.NoteManager.GetDisplayStatus ( NXOpen.TaggedObject  notes)
inline

Get display status of annotation

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
notes
Returns
Array of notes
unsafe NXOpen.TaggedObject NXOpen.CAE.NoteManager.GetFolderOfAnnotation ( NXOpen.Annotations.NoteBase  annotation)
inline

Gets Folder of an existing annotation

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
annotation
Returns
unsafe void NXOpen.CAE.NoteManager.HideNotes ( NXOpen.TaggedObject[]  noteArray)
inline

Hide annotations

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
noteArrayArray of notes
unsafe void NXOpen.CAE.NoteManager.MoveNotesToFolder ( NXOpen.CAE.NoteFolder  folder,
NXOpen.Annotations.NoteBase[]  annotation 
)
inline

Move notes to specified folder

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
folder
annotation
unsafe void NXOpen.CAE.NoteManager.RenameFolder ( NXOpen.CAE.NoteFolder  folder,
string  folderName 
)
inline

Rename specified folder

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
folder
folderName
unsafe void NXOpen.CAE.NoteManager.SetOrigin ( NXOpen.TaggedObject  note,
NXOpen.Point3d  origin 
)
inline

Move annotation to a new location

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
note
origin
unsafe void NXOpen.CAE.NoteManager.SetParallelToScreen ( bool  parallelToScreen,
NXOpen.CAE.CaeNote[]  annotations 
)
inline

Sets the parallel to screen status on each input annotation.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
parallelToScreenParallel to Screen Setting
annotationsAnnotations to be set
unsafe void NXOpen.CAE.NoteManager.SetText ( NXOpen.TaggedObject  note,
string[]  lines 
)
inline

Set new text in annotation

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
note
lines
unsafe void NXOpen.CAE.NoteManager.ShowNotes ( NXOpen.TaggedObject[]  noteArray)
inline

Display hidden annotations

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
noteArrayArray of notes
NXOpen.CAE.NoteFolder [] NXOpen.CAE.NoteManager.ToArray ( )
inline

Returns an array of NXOpen.CAE.NoteFolder objects.

Property Documentation

Tag NXOpen.CAE.NoteManager.Tag
get

Returns the tag of this object.


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