PostAnnotation Class

class NXOpen.CAE.PostAnnotation

Bases: NXOpen.TransientObject

Controls appearance of a annoation object in a postview. User must call CAE.PostAnnotation.Draw() to make changes visible.

To obtain an instance of this class use CAE::Post

New in version NX8.5.0.

Properties

Property	Description
BoxColor	Returns or sets the box color
BoxFill	Returns or sets the box filling
BoxTextAlignment	Returns or sets the text alignment
BoxTranluceny	Returns or sets the box tranluceny
BoxTranslucency	Returns or sets the box translucency
DisplayStyle	Returns or sets the annotation style
DisplayValueType	Returns or sets the annotation value type
DrawBox	Returns or sets the box drawing
Name	Returns or sets the annotation name
TextColor	Returns or sets the text color

Methods

Method	Description
Delete	Deletes the annotation.
Dispose	Frees the object from memory.
Draw	Draw annotation object on graphics screen.
GetUserText	Ask the user text in each box
SetUserText	Put the user text in each box
Show	Show/Hide annotation object on graphics screen.

Enumerations

PostAnnotationStyle Enumeration	Annotation styles
PostAnnotationTextAlignment Enumeration	Annotation text alignment
PostAnnotationValueType Enumeration	Annotation value type

Property Detail

BoxColor

PostAnnotation.BoxColor

Returns or sets the box color

-------------------------------------

Getter Method

Signature BoxColor

Returns: Return type:Id

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature BoxColor

Parameters:boxColor (Id) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

BoxFill

PostAnnotation.BoxFill

Returns or sets the box filling

-------------------------------------

Getter Method

Signature BoxFill

Returns: Return type:bool

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature BoxFill

Parameters:boxFill (bool) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

BoxTextAlignment

PostAnnotation.BoxTextAlignment

Returns or sets the text alignment

-------------------------------------

Getter Method

Signature BoxTextAlignment

Returns: Return type:NXOpen.CAE.PostAnnotationTextAlignment

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature BoxTextAlignment

Parameters:boxTextAlignment (NXOpen.CAE.PostAnnotationTextAlignment) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

BoxTranluceny

PostAnnotation.BoxTranluceny

Returns or sets the box tranluceny

-------------------------------------

Getter Method

Signature BoxTranluceny

Returns: Return type:bool

New in version NX8.5.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.PostAnnotation.BoxTranslucency() instead.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature BoxTranluceny

Parameters:boxTranluceny (bool) –

New in version NX8.5.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.PostAnnotation.BoxTranslucency() instead.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

BoxTranslucency

PostAnnotation.BoxTranslucency

Returns or sets the box translucency

-------------------------------------

Getter Method

Signature BoxTranslucency

Returns: Return type:bool

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature BoxTranslucency

Parameters:boxTranslucency (bool) –

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

DisplayStyle

PostAnnotation.DisplayStyle

Returns or sets the annotation style

-------------------------------------

Getter Method

Signature DisplayStyle

Returns: Return type:NXOpen.CAE.PostAnnotationStyle

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature DisplayStyle

Parameters:style (NXOpen.CAE.PostAnnotationStyle) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

DisplayValueType

PostAnnotation.DisplayValueType

Returns or sets the annotation value type

-------------------------------------

Getter Method

Signature DisplayValueType

Returns: Return type:NXOpen.CAE.PostAnnotationValueType

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature DisplayValueType

Parameters:valueType (NXOpen.CAE.PostAnnotationValueType) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

DrawBox

PostAnnotation.DrawBox

Returns or sets the box drawing

-------------------------------------

Getter Method

Signature DrawBox

Returns: Return type:bool

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature DrawBox

Parameters:drawBox (bool) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

Name

PostAnnotation.Name

Returns or sets the annotation name

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

TextColor

PostAnnotation.TextColor

Returns or sets the text color

-------------------------------------

Getter Method

Signature TextColor

Returns: Return type:Id

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

-------------------------------------

Setter Method

Signature TextColor

Parameters:textColor (Id) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

Method Detail

Delete

PostAnnotation.Delete

Deletes the annotation.

Signature Delete()

New in version NX10.0.0.

License requirements: None.

Dispose

PostAnnotation.Dispose

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Signature Dispose()

New in version NX8.5.0.

License requirements: None.

Draw

PostAnnotation.Draw

Draw annotation object on graphics screen.

If NX is in batch mode, nothing happens. After setting paramters user has to call draw to reflect changes.

Signature Draw()

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

GetUserText

PostAnnotation.GetUserText

Ask the user text in each box

Signature GetUserText()

Returns: Return type:list of str

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

SetUserText

PostAnnotation.SetUserText

Put the user text in each box

Signature SetUserText(usertext)

Parameters:usertext (list of str) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

Show

PostAnnotation.Show

Show/Hide annotation object on graphics screen.

If NX is in batch mode, nothing happens

Signature Show(show)

Parameters:show (bool) – true will show annotation, false will hide

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)