NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::UIStyler::StringItem Class Reference

Represents a StringItem for UI Styler. More...

Inheritance diagram for NXOpen::UIStyler::StringItem:
NXOpen::UIStyler::StylerItem NXOpen::TransientObject

List of all members.

Public Types

typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
Activate
 Called when a dialog user enters a character string and presses Return.

Public Member Functions

void AddActivateHandler (const NXOpen::UIStyler::StringItem::Activate &activateevent, bool isDialogLaunchingEvent)
 Registers activate callback.
bool GetSensitivity ()
 To get senstivity of string control.
NXString ItemValue ()
 Returns the string value for this dialog item.
void SetBitmap (const NXString &strBitmap)
 Specifies a filename that contains a bitmap definition.
void SetFocus ()
 Indicates that this dialog item is receiving keyboard focus
Created in NX5.0.0.
void SetItemValue (const NXString &itemVal)
 Sets the string value for this dialog item.
void SetLabel (const NXString &strLabel)
 Specifies descriptive text to display for the dialog item.
void SetSensitivity (bool type)
 Specifies the sensitivity of the dialog item.
void SetVisibility (bool type)
 Sets the visibility of the dialog item
Created in NX5.0.0.
bool Visibility ()
 Returns the visibility of the dialog item
Created in NX5.0.0.

Detailed Description

Represents a StringItem for UI Styler.


Created in NX5.0.0.


Member Typedef Documentation

Called when a dialog user enters a character string and presses Return.


Created in NX5.0.0.

License requirements : None


Member Function Documentation

void NXOpen::UIStyler::StringItem::AddActivateHandler ( const NXOpen::UIStyler::StringItem::Activate activateevent,
bool  isDialogLaunchingEvent 
)

Registers activate callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters:
activateeventactivateevent
isDialogLaunchingEventis dialog launching event

To get senstivity of string control.

Returns:
TRUE if sensitive, FALSE if insensitive
Created in NX5.0.0.

License requirements : None

Returns the string value for this dialog item.

It can be the initial value that is programmatically defined, or interactively entered by the user.
Created in NX5.0.0.

License requirements : None

Specifies a filename that contains a bitmap definition.

The filename must contain a UBM, XPM, or BMP extension. When you use this field, the system displays a bitmap for this dialog item instead of a text label. When a bitmap is present, the system uses the text label as tooltip text when a user places the mouse cursor over the bitmap. We recommend that you use a 16x16 bitmap for this dialog item.
Created in NX5.0.0.

License requirements : None

Parameters:
strBitmapFilename with .ubm, .xpm, or .bmp extension that contains bitmap definition
NOTE: The full Unicode character set is not supported for this parameter.

Indicates that this dialog item is receiving keyboard focus
Created in NX5.0.0.



License requirements : None

Sets the string value for this dialog item.

It can be the initial value that is programmatically defined, or interactively entered by the user.
Created in NX5.0.0.

License requirements : None

Parameters:
itemValString value

Specifies descriptive text to display for the dialog item.

It should describe the dialog item's intended use. If you specify a bitmap for this dialog item, it uses this text as tooltip text.


Created in NX5.0.0.

License requirements : None

Parameters:
strLabelString label to display on the left side of the text field
NOTE: The full Unicode character set is not supported for this parameter.

Specifies the sensitivity of the dialog item.

When you set sensitivity to False, it grays out the dialog item. This indicates that the dialog item exists but is not active.
Created in NX5.0.0.

License requirements : None

Parameters:
typeTRUE if sensitive, FALSE if insensitive

Sets the visibility of the dialog item
Created in NX5.0.0.



License requirements : None

Parameters:
typeTRUE if visible, FALSE if invisible

Returns the visibility of the dialog item
Created in NX5.0.0.



License requirements : None


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