NXOpen .NET Reference  12.0.0
Public Types | 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:

Public Types

enum  FolderType { New, Existing }
 Select folder for new note More...
 

Public Member Functions

NXOpen.CAE.NoteFolder[] ToArray ()
 Returns an array of NXOpen.CAE.NoteFolder objects. More...
 
unsafe NXOpen.CAE.CaeNoteBuilder CreateCaeNoteBuilder (NXOpen.Annotations.SimpleDraftingAid annotation)
 Creates a builder for cae annotation command More...
 
unsafe NXOpen.CAE.NoteFolder CreateNoteFolder (string folderName)
 Creates a folder for cae annotation More...
 
unsafe NXOpen.TaggedObject GetFolderOfAnnotation (NXOpen.Annotations.NoteBase annotation)
 Gets Folder of an existing annotation More...
 
unsafe void MoveNotesToFolder (NXOpen.CAE.NoteFolder folder, NXOpen.Annotations.NoteBase[] annotation)
 Move notes to specified folder More...
 
unsafe void DeleteFolder (NXOpen.CAE.NoteFolder folder)
 Delete specified folder More...
 
unsafe void RenameFolder (NXOpen.CAE.NoteFolder folder, string folderName)
 Rename specified folder More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. 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 Enumeration Documentation

Select folder for new note

Enumerator
New 

Create new folder

Existing 

Add to Existing folder

Member Function Documentation

unsafe NXOpen.CAE.CaeNoteBuilder NXOpen.CAE.NoteManager.CreateCaeNoteBuilder ( NXOpen.Annotations.SimpleDraftingAid  annotation)

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.NoteFolder NXOpen.CAE.NoteManager.CreateNoteFolder ( string  folderName)

Creates a folder for cae annotation

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

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

Delete specified folder

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

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

Advances the enumerator to the next element of the collection.

unsafe NXOpen.TaggedObject NXOpen.CAE.NoteManager.GetFolderOfAnnotation ( NXOpen.Annotations.NoteBase  annotation)

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.MoveNotesToFolder ( NXOpen.CAE.NoteFolder  folder,
NXOpen.Annotations.NoteBase[]  annotation 
)

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 
)

Rename specified folder

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
folder
folderName
NXOpen.CAE.NoteFolder [] NXOpen.CAE.NoteManager.ToArray ( )

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 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.