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 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”)

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

Setter Method

Signature BoxColor(boxColor)

Parameters:	boxColor (Id) –

New in version NX8.5.0.

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

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”)

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

Setter Method

Signature BoxFill(boxFill)

Parameters:	boxFill (bool) –

New in version NX8.5.0.

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

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”)

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

Setter Method

Signature BoxTextAlignment(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”)

BoxTranluceny¶

PostAnnotation.BoxTranluceny¶

Returns or sets the box translucency

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

Getter Method

Signature BoxTranluceny()

Returns:
Return type:	bool

New in version NX8.5.0.

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

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

Setter Method

Signature BoxTranluceny(boxTranluceny)

Parameters:	boxTranluceny (bool) –

New in version NX8.5.0.

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

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”)

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

Setter Method

Signature DisplayStyle(style)

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”)

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”)

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

Setter Method

Signature DisplayValueType(valueType)

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”)

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”)

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

Setter Method

Signature DrawBox(drawBox)

Parameters:	drawBox (bool) –

New in version NX8.5.0.

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

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”)

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

Setter Method

Signature Name(name)

Parameters:	name (str) –

New in version NX8.5.0.

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

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”)

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

Setter Method

Signature TextColor(textColor)

Parameters:	textColor (Id) –

New in version NX8.5.0.

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

Method Detail¶

Delete¶

PostAnnotation.Delete¶

Deletes the annotation.

User must call TransientObject.Dispose() after calling this method.

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”)

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”)

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”)

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”)