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

Represents a DialogItem for UI Styler. More...

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

Public Types

enum  ItemType {
  PushButton, DialogItem, RadioBox, RealItem,
  RealScale, Bitmap, RowColumn, ButtonLayout,
  ScrolledWindow, ColorTool, SelectionBox, Separator,
  SingleSelectList, StringItem, GroupBox, IntegerItem,
  IntegerScale, MultiSelectList, LabelItem, MultiTextBox,
  TabControl, OptionMenu, Toggle, OptionToggle,
  ToolPalette, WideString, PropertyPage, CollapsibleGroup
}
 Represents dialog item type More...
 

Public Member Functions

unsafe NXOpen.UIStyler.BitMap GetBitmap (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.ButtonLayout GetButtonLayout (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe
NXOpen.UIStyler.CollapsibleGroup 
GetCollapsibleGroup (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.ColorTool GetColorTool (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.DialogItem GetDialogIndex (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.StylerItem GetDialogItemUsingSelectionHandle (NXOpen.SelectionHandle select)
 Gets the dialog item for a selection handle More...
 
unsafe NXOpen.UIStyler.GroupBox GetGroupBox (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.IntegerItem GetIntegerItem (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.IntegerScale GetIntegerScale (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.LabelItem GetLabelItem (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe
NXOpen.UIStyler.MultiSelectList 
GetMultiSelectList (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.MultiTextBox GetMultiTextBox (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.OptionMenu GetOptionMenu (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.OptionToggle GetOptionToggle (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.PropertyPage GetPropertyPage (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.PushButton GetPushButton (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.RadioBox GetRadioBox (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.RealItem GetRealItem (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.RealScale GetRealScale (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.RowColumn GetRowColumn (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe
NXOpen.UIStyler.ScrolledWindow 
GetScrolledWindow (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.SelectionBox GetSelectionBox (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.Separator GetSeparator (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe
NXOpen.UIStyler.SingleSelectList 
GetSingleSelectList (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.StringItem GetStringItem (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.StylerItem GetStylerItem (string itemIdentifier, NXOpen.UIStyler.Dialog.ItemType type)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.TabControl GetTabControl (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.Toggle GetToggle (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.ToolPalette GetToolPalette (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe NXOpen.UIStyler.WideString GetWideString (string itemIdentifier)
 Gets the dialog item with specified item identifier More...
 
unsafe void RegisterWithUiMenu (bool isTopDialog)
 Registers the dialog with a menu item. More...
 
unsafe
NXOpen.UIStyler.DialogResponse 
Show ()
 Displays an NX (UIStyler generated) "bottom" dialog. 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 ()
 Free resources associated with the instance. More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents a DialogItem for UI Styler.

Created in NX5.0.0

Member Enumeration Documentation

Represents dialog item type

Enumerator
PushButton 
DialogItem 
RadioBox 
RealItem 
RealScale 
Bitmap 
RowColumn 
ButtonLayout 
ScrolledWindow 
ColorTool 
SelectionBox 
Separator 
SingleSelectList 
StringItem 
GroupBox 
IntegerItem 
IntegerScale 
MultiSelectList 
LabelItem 
MultiTextBox 
TabControl 
OptionMenu 
Toggle 
OptionToggle 
ToolPalette 
WideString 
PropertyPage 
CollapsibleGroup 

Member Function Documentation

override void NXOpen.UIStyler.Dialog.FreeResource ( )
inlineprotectedvirtual

Free resources associated with the instance.

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

Created in NX5.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe NXOpen.UIStyler.BitMap NXOpen.UIStyler.Dialog.GetBitmap ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.ButtonLayout NXOpen.UIStyler.Dialog.GetButtonLayout ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.CollapsibleGroup NXOpen.UIStyler.Dialog.GetCollapsibleGroup ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.ColorTool NXOpen.UIStyler.Dialog.GetColorTool ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.DialogItem NXOpen.UIStyler.Dialog.GetDialogIndex ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.StylerItem NXOpen.UIStyler.Dialog.GetDialogItemUsingSelectionHandle ( NXOpen.SelectionHandle  select)
inline

Gets the dialog item for a selection handle

Created in NX5.0.0

License requirements: None.

Parameters
selectSelection handle
Returns
unsafe NXOpen.UIStyler.GroupBox NXOpen.UIStyler.Dialog.GetGroupBox ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.IntegerItem NXOpen.UIStyler.Dialog.GetIntegerItem ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.IntegerScale NXOpen.UIStyler.Dialog.GetIntegerScale ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.LabelItem NXOpen.UIStyler.Dialog.GetLabelItem ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.MultiSelectList NXOpen.UIStyler.Dialog.GetMultiSelectList ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.MultiTextBox NXOpen.UIStyler.Dialog.GetMultiTextBox ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.OptionMenu NXOpen.UIStyler.Dialog.GetOptionMenu ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.OptionToggle NXOpen.UIStyler.Dialog.GetOptionToggle ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.PropertyPage NXOpen.UIStyler.Dialog.GetPropertyPage ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.PushButton NXOpen.UIStyler.Dialog.GetPushButton ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.RadioBox NXOpen.UIStyler.Dialog.GetRadioBox ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.RealItem NXOpen.UIStyler.Dialog.GetRealItem ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.RealScale NXOpen.UIStyler.Dialog.GetRealScale ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.RowColumn NXOpen.UIStyler.Dialog.GetRowColumn ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.ScrolledWindow NXOpen.UIStyler.Dialog.GetScrolledWindow ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.SelectionBox NXOpen.UIStyler.Dialog.GetSelectionBox ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.Separator NXOpen.UIStyler.Dialog.GetSeparator ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.SingleSelectList NXOpen.UIStyler.Dialog.GetSingleSelectList ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.StringItem NXOpen.UIStyler.Dialog.GetStringItem ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.StylerItem NXOpen.UIStyler.Dialog.GetStylerItem ( string  itemIdentifier,
NXOpen.UIStyler.Dialog.ItemType  type 
)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
type
Returns
unsafe NXOpen.UIStyler.TabControl NXOpen.UIStyler.Dialog.GetTabControl ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.Toggle NXOpen.UIStyler.Dialog.GetToggle ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.ToolPalette NXOpen.UIStyler.Dialog.GetToolPalette ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe NXOpen.UIStyler.WideString NXOpen.UIStyler.Dialog.GetWideString ( string  itemIdentifier)
inline

Gets the dialog item with specified item identifier

Created in NX5.0.0

License requirements: None.

Parameters
itemIdentifierDialog name
Returns
unsafe void NXOpen.UIStyler.Dialog.RegisterWithUiMenu ( bool  isTopDialog)
inline

Registers the dialog with a menu item.

Created in NX5.0.0

License requirements: None.

Parameters
isTopDialog
unsafe NXOpen.UIStyler.DialogResponse NXOpen.UIStyler.Dialog.Show ( )
inline

Displays an NX (UIStyler generated) "bottom" dialog.

This dialog is displayed to NX. Show Method can only be called once for the dialog object.Once show method is called UIStyler.Dialog.GetStylerItem will create any item

Created in NX5.0.0

License requirements: None.

Returns

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