NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Member Functions | Properties | List of all members
NXOpen.UIStyler.OptionMenu Class Reference

Represents a OptionMenu for UI Styler. More...

Inheritance diagram for NXOpen.UIStyler.OptionMenu:
NXOpen.UIStyler.StylerItem NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Classes

class  _OptionMenuActivateAdapter
 

Public Member Functions

delegate
NXOpen.UIStyler.DialogState 
Activate (NXOpen.UIStyler.StylerEvent eventobject)
 Called when a dialog user selects an option from the menu. More...
 
unsafe void AddActivateHandler (NXOpen.UIStyler.OptionMenu.Activate activateevent, bool isDialogLaunchingEvent)
 Registers activate callback. More...
 
unsafe string[] GetBitmap ()
 Returns an array of bitmaps More...
 
unsafe string[] GetItems ()
 Returns an array if items More...
 
unsafe bool GetSensitivity ()
 Gets the sensitivity More...
 
unsafe void SetBitmap (string[] bitmaps)
 Set an array of bitmap filenames More...
 
unsafe void SetItems (string[] strListArray)
 Set an array of items More...
 
unsafe void SetLabel (string strLabel)
 Sets label More...
 
unsafe void SetSensitivity (int subitemIndex, bool type)
 Sets the sensitivity More...
 
- Public Member Functions inherited from NXOpen.UIStyler.StylerItem
unsafe
NXOpen.UIStyler.StylerItem.ItemType 
GetItemType ()
 Gets the dialog item type. More...
 
unsafe NXOpen.UIStyler.Attachment InitializeAttachment ()
 Returns initialized dialog item attachment information More...
 
unsafe bool IsEqualTo (NXOpen.UIStyler.StylerItem itemToCompare)
 Equates two styler items More...
 
unsafe void SetAttachment (NXOpen.UIStyler.Attachment attachment)
 Specifies the updated dialog item attachment information 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...
 

Properties

unsafe int ItemValue [get, set]
 Returns or sets the item value More...
 
unsafe bool Visibility [get, set]
 Returns or sets the visibility More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.UIStyler.StylerItem
enum  ItemType {
  InvalidType = -1, ActionButton, Dialog, RadioBox,
  Real, ScaleReal, Bitmap, RowColumn,
  ButtonLayout, ScrolledWindow, ColorTool, SelectionBox,
  Separator, SingleSelectionList, String, BeginGroup,
  Integer, ScaleInteger, MultiList, Label,
  MultiLineText, TabControl, OptionMenu, Toggle,
  OptionToggle, ToolPalette, WideString, PropertyPage,
  CollapsibleGroup
}
 Describes kind of action to be taken from callbac. More...
 
- Protected Member Functions inherited from NXOpen.UIStyler.StylerItem
override void FreeResource ()
 Free resources associated with the instance. More...
 

Detailed Description

Represents a OptionMenu for UI Styler.

Created in NX5.0.0

Member Function Documentation

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.OptionMenu.Activate ( NXOpen.UIStyler.StylerEvent  eventobject)

Called when a dialog user selects an option from the menu.

Created in NX5.0.0

License requirements: None.

Parameters
eventobjectEvent object
unsafe void NXOpen.UIStyler.OptionMenu.AddActivateHandler ( NXOpen.UIStyler.OptionMenu.Activate  activateevent,
bool  isDialogLaunchingEvent 
)
inline

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
activateeventCallback for activate event
isDialogLaunchingEventTRUE if dialog is going to launch, FALSE if not
unsafe string [] NXOpen.UIStyler.OptionMenu.GetBitmap ( )
inline

Returns an array of bitmaps

Created in NX5.0.0

License requirements: None.

Returns
unsafe string [] NXOpen.UIStyler.OptionMenu.GetItems ( )
inline

Returns an array if items

Created in NX5.0.0

License requirements: None.

Returns
unsafe bool NXOpen.UIStyler.OptionMenu.GetSensitivity ( )
inline

Gets the sensitivity

Created in NX5.0.0

License requirements: None.

Returns
unsafe void NXOpen.UIStyler.OptionMenu.SetBitmap ( string[]  bitmaps)
inline

Set an array of bitmap filenames

Created in NX5.0.0

License requirements: None.

Parameters
bitmapsAn array of one or more bitmap filenames. If all bitmaps for the option menu reside in the same file, specify an array of just one entry, which contains the bitmap filename for this attribute. All existing choices for the option menu remains intact when this attribute is set. Only the bitmaps are changed. Note that the number of bitmaps must match the number of existing choices.
unsafe void NXOpen.UIStyler.OptionMenu.SetItems ( string[]  strListArray)
inline

Set an array of items

Created in NX5.0.0

License requirements: None.

Parameters
strListArrayAn array of new choices to be used for the dialog item. Note that this removes all existing choices (both text and bitmaps)
unsafe void NXOpen.UIStyler.OptionMenu.SetLabel ( string  strLabel)
inline

Sets label

Created in NX5.0.0

License requirements: None.

Parameters
strLabelText to be set for the descriptive label.
unsafe void NXOpen.UIStyler.OptionMenu.SetSensitivity ( int  subitemIndex,
bool  type 
)
inline

Sets the sensitivity

Created in NX5.0.0

License requirements: None.

Parameters
subitemIndexIf the entire dialog item should change to the new Sensitivity state, set this field to UF_STYLER_NO_SUB_INDEX. If only one subitem should change to the new sensitivity state, set this field to its zero-based index.
typeTRUE if sensitive, FALSE if insensitive

Property Documentation

unsafe int NXOpen.UIStyler.OptionMenu.ItemValue
getset

Returns or sets the item value

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.UIStyler.OptionMenu.Visibility
getset

Returns or sets the visibility

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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