NXOpen .NET Reference Guide
|
Represents temporary text strings which can be used for Temporary Display More...
Public Types | |
enum | StandardTextRef { SystemDefault, BaselineStart = 0, BaselineCenter, BaselineEnd, TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight } |
This enumerated type specifies the type of reference point used in the text box for standard_text methods. More... | |
enum | TextSize { Small, Normal, Medium = 1, Large, NumSizes } |
Provides a way to specify the size of the desired text, as small, medium or large (normal is a synonym for medium). More... | |
enum | ViewType { WorkViewOnly, AllActiveViews, ViewOfLastCursor, AllViewsButDrawing, AllActiveMemberViews, FirstViewFound } |
the view or views in which the transient text is to be displayed. More... | |
Public Member Functions | |
unsafe void | AddTextString (string textString) |
Adds a text string to the TransientText object. More... | |
unsafe void | DisplayTemporaryAbsoluteGeometry (int fontIndex, NXOpen.View view, NXOpen.Display.TransientText.ViewType viewType, NXOpen.DisplayableObject @object, NXOpen.Point3d position) |
Displays text as temporary display using absolute geometry. More... | |
unsafe void | DisplayTemporaryAbsRotScreenSizeGeometry (int fontIndex, NXOpen.View view, NXOpen.Display.TransientText.ViewType viewType, NXOpen.DisplayableObject @object, NXOpen.Point3d position) |
Displays text as temporary display using screen geometry but with rotation defined in absolute space. More... | |
unsafe void | DisplayTemporaryScreenGeometry (int fontIndex, NXOpen.View view, NXOpen.Display.TransientText.ViewType viewType, NXOpen.DisplayableObject @object, NXOpen.Point3d position) |
Displays text as temporary display using screen geometry. More... | |
unsafe void | GetAbsoluteTextSize (out double glyphWidth, out double glyphHeight) |
Returns the size of the text, in absolute coordinate, in units of the displayed part. More... | |
unsafe void | SetAbsoluteTextSize (double glyphWidth, double glyphHeight) |
Sets the size of the text, in absolute coordinates, in units of the displayed part. More... | |
Public Member Functions inherited from NXOpen.TransientObject | |
void | Dispose () |
Frees the object from memory. More... | |
void | PrintTestData (String variableName) |
<exclude> More... | |
void | PrintTestData (String variableName, int lineNumber) |
<exclude> More... | |
new string | ToString () |
Returns a String that represents the current Object. 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 void | FreeResource () |
Frees the object from memory. More... | |
Properties | |
unsafe int | Color [get, set] |
Returns or sets the index of the color to be used to display the transient text. More... | |
unsafe string | FontStyle [get, set] |
Returns or sets the style of font to be used to display the transient text. More... | |
unsafe NXOpen.Display.TransientText.StandardTextRef | ReferencePositionType [get, set] |
Returns or sets the position of the text relative to positions on the text box More... | |
unsafe NXOpen.Display.TransientText.TextSize | ScreenTextSize [get, set] |
Returns or sets the approximate size of the text (small, mendium, large) as measured on the graphics screen. More... | |
Properties inherited from NXOpen.TransientObject | |
IntPtr | Handle [get] |
Handle of the internal object represented by this object. More... | |
Properties inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageSink | NextSink [get] |
Gets the next message sink in the sink chain. More... | |
Represents temporary text strings which can be used for Temporary Display
Created in NX8.0.0
This enumerated type specifies the type of reference point used in the text box for standard_text methods.
|
inline |
Adds a text string to the TransientText object.
A TransientText object may have one or more text strings. If an attempt is made to display a TransientText object with zero text strings, an error will be returned.
Created in NX8.0.0
License requirements: None.
textString |
|
inline |
Displays text as temporary display using absolute geometry.
Insure that you have set all needed properties before using this method. Note that the text will be displayed on the Absolute XY plane.
Created in NX8.0.0
License requirements: None.
fontIndex | The index of the font to be used. This may be 0, which means to use the default font. |
view | The view in which to display the text. This may be a null reference (Nothing in Visual Basic), in which case the viewType argument is used. |
viewType | Used only when view is a null reference (Nothing in Visual Basic). |
object | May be a null reference (Nothing in Visual Basic), in which case the text will be drawn at the given position. If not a null reference (Nothing in Visual Basic), draw the text at the attention point of object. |
position | In Absolute Coordinates |
|
inline |
Displays text as temporary display using screen geometry but with rotation defined in absolute space.
The text will be displayed on the XY plane of the absolute coordinate system. Insure that you have set all needed properties before using this method. This method is not supported for 2D output such as CGM.
Created in NX8.0.0
License requirements: None.
fontIndex | The index of the font to be used. This may be 0, which means to use the default font. |
view | The view in which to display the text. This may be a null reference (Nothing in Visual Basic), in which case the viewType argument is used. |
viewType | Used only when view is a null reference (Nothing in Visual Basic). |
object | May be a null reference (Nothing in Visual Basic), in which case the text will be drawn at the given position. If not a null reference (Nothing in Visual Basic), draw the text at the attention point of object. |
position | In Absolute Coordinates |
|
inline |
Displays text as temporary display using screen geometry.
Insure that you have set all needed properties before using this method. This method is not supported for 2D output such as CGM. Note that the text will be displayed on the Absolute XY plane.
Created in NX8.0.0
License requirements: None.
fontIndex | The index of the font to be used. This may be 0, which means to use the default font. |
view | The view in which to display the text. This may be a null reference (Nothing in Visual Basic), in which case the viewType argument is used. |
viewType | Used only when view is a null reference (Nothing in Visual Basic). |
object | May be a null reference (Nothing in Visual Basic), in which case the text will be drawn at the given position. If not a null reference (Nothing in Visual Basic), draw the text at the attention point of object. |
position | In Absolute Coordinates |
|
inlineprotectedvirtual |
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.
Created in NX8.0.0
License requirements: None.
Implements NXOpen.TransientObject.
|
inline |
Returns the size of the text, in absolute coordinate, in units of the displayed part.
These values are only only used by Display.TransientText.DisplayTemporaryAbsoluteGeometry .
Created in NX8.0.0
License requirements: None.
glyphWidth | |
glyphHeight |
|
inline |
Sets the size of the text, in absolute coordinates, in units of the displayed part.
These values are only used by Display.TransientText.DisplayTemporaryAbsoluteGeometry .
Created in NX8.0.0
License requirements: None.
glyphWidth | |
glyphHeight |
|
getset |
Returns or sets the index of the color to be used to display the transient text.
If not specified, the System Color will be used.
Created in NX8.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the style of font to be used to display the transient text.
Every text font has at least one style. To determine which styles a font has, use UF_UGFONT_ask_font_styles. If not specified, the default font style for the font will be used.
Created in NX8.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the position of the text relative to positions on the text box
Created in NX8.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the approximate size of the text (small, mendium, large) as measured on the graphics screen.
This property is not used by Display.TransientText.DisplayTemporaryAbsoluteGeometry .
Created in NX8.0.0
License requirements to get this property: None.
License requirements to set this property: None.