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

Represents a ListBox block More...

Inheritance diagram for NXOpen.BlockStyler.ListBox:
NXOpen.BlockStyler.UIBlock NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

class  _ListBoxAddCallbackAdapter
 
class  _ListBoxDeleteCallbackAdapter
 

Public Member Functions

delegate int AddCallback (NXOpen.BlockStyler.ListBox list)
 Add callback More...
 
delegate int DeleteCallback (NXOpen.BlockStyler.ListBox list)
 Delete callback. More...
 
unsafe string[] GetListItems ()
 Gets the ListItems More...
 
unsafe int[] GetSelectedItemBooleans ()
 Gets the SelectedItemBooleans. More...
 
unsafe int[] GetSelectedItems ()
 Gets SelectedItems More...
 
unsafe string[] GetSelectedItemStrings ()
 Gets the SelectedItemStrings More...
 
unsafe void SetAddHandler (NXOpen.BlockStyler.ListBox.AddCallback cb)
 Sets the Add handler. More...
 
unsafe void SetDeleteHandler (NXOpen.BlockStyler.ListBox.DeleteCallback cb)
 Sets the Delete handler. More...
 
unsafe void SetListItems (string[] items)
 Sets the ListItems More...
 
unsafe void SetSelectedItemBooleans (int[] items)
 Sets the SelectedItemStrings. More...
 
unsafe void SetSelectedItems (int[] selectedItems)
 Sets SelectedItems More...
 
unsafe void SetSelectedItemStrings (string[] strings)
 Sets the SelectedItemStrings. More...
 
- Public Member Functions inherited from NXOpen.BlockStyler.UIBlock
unsafe void Focus ()
 Focuses on the block. More...
 
unsafe
NXOpen.BlockStyler.PropertyList 
GetProperties ()
 Returns the properties of the block More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override 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 bool AllowDeselectForSingleSelect [get, set]
 Returns or sets the AllowDeselectForSingleSelect. More...
 
unsafe int Height [get, set]
 Returns or sets the Height More...
 
unsafe bool IsAddButtonSensitive [get, set]
 Returns or sets the IsAddButtonSensitive More...
 
unsafe bool IsDeleteButtonSensitive [get, set]
 Returns or sets the IsDeleteButtonSensitive More...
 
unsafe bool Localize [get, set]
 Returns or sets the Localize. More...
 
unsafe int MaximumHeight [get, set]
 Returns or sets the MaximumHeight More...
 
unsafe int MaximumStringLength [get, set]
 Returns or sets the MaximumStringLength More...
 
unsafe int MinimumHeight [get, set]
 Returns or sets the MinimumHeight More...
 
unsafe bool ResizeHeightWithDialog [get, set]
 Returns or sets the ResizeHeightWithDialog More...
 
unsafe int SelectedItemIndex [get, set]
 Returns or sets the SelectedItemIndex. More...
 
unsafe string SelectedItemString [get, set]
 Returns or sets the SelectedItemString. More...
 
unsafe bool ShowAddButton [get, set]
 Returns or sets the ShowAddButton. More...
 
unsafe bool ShowDeleteButton [get, set]
 Returns or sets the ShowDeleteButton. More...
 
unsafe bool ShowMoveUpDownButtons [get, set]
 Returns or sets the ShowMoveUpDownButtons. More...
 
unsafe bool SingleSelect [get, set]
 Returns or sets the SingleSelect. More...
 
- Properties inherited from NXOpen.BlockStyler.UIBlock
unsafe bool Enable [get, set]
 Returns or sets the Enable. More...
 
unsafe bool Expanded [get, set]
 Returns or sets the Expanded More...
 
unsafe bool Group [get, set]
 Returns or sets the Group More...
 
unsafe string Label [get, set]
 Returns or sets the Label More...
 
unsafe string Name [get]
 Returns the name of the block or BlockID More...
 
unsafe bool Show [get, set]
 Returns or sets the Visibility of block. More...
 
unsafe string Type [get]
 Returns the type of block More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a ListBox block

Created in NX6.0.0

Member Function Documentation

delegate int NXOpen.BlockStyler.ListBox.AddCallback ( NXOpen.BlockStyler.ListBox  list)

Add callback

Created in NX6.0.0

License requirements: None.

Parameters
list
delegate int NXOpen.BlockStyler.ListBox.DeleteCallback ( NXOpen.BlockStyler.ListBox  list)

Delete callback.

Return a non-zero value in order to veto the deletion.

Created in NX6.0.0

License requirements: None.

Parameters
list
unsafe string [] NXOpen.BlockStyler.ListBox.GetListItems ( )
inline

Gets the ListItems

Created in NX8.5.0

License requirements: None.

Returns
unsafe int [] NXOpen.BlockStyler.ListBox.GetSelectedItemBooleans ( )
inline

Gets the SelectedItemBooleans.

This method returns an integer array of boolen values populated with 0 and 1

Created in NX8.5.0

License requirements: None.

Returns
unsafe int [] NXOpen.BlockStyler.ListBox.GetSelectedItems ( )
inline

Gets SelectedItems

Created in NX8.5.0

License requirements: None.

Returns
selected items
unsafe string [] NXOpen.BlockStyler.ListBox.GetSelectedItemStrings ( )
inline

Gets the SelectedItemStrings

Created in NX8.5.0

License requirements: None.

Returns
unsafe void NXOpen.BlockStyler.ListBox.SetAddHandler ( NXOpen.BlockStyler.ListBox.AddCallback  cb)
inline

Sets the Add handler.

This handler is called when the Add button is pressed. The handler is responsible for adding an item to the list. Nothing will be added to the list unless the handler adds it.

Created in NX6.0.0

License requirements: None.

Parameters
cb
unsafe void NXOpen.BlockStyler.ListBox.SetDeleteHandler ( NXOpen.BlockStyler.ListBox.DeleteCallback  cb)
inline

Sets the Delete handler.

If you set this handler, the handler will be called when the Delete button is pressed. The handler does not need to implement code to delete the item. The list will delete the selected items if and only if the handler returns 0.

Created in NX6.0.0

License requirements: None.

Parameters
cb
unsafe void NXOpen.BlockStyler.ListBox.SetListItems ( string[]  items)
inline

Sets the ListItems

Created in NX8.5.0

License requirements: None.

Parameters
items
unsafe void NXOpen.BlockStyler.ListBox.SetSelectedItemBooleans ( int[]  items)
inline

Sets the SelectedItemStrings.

Selects the list items based on input boolean array. Item is deselcted if value is 0 and selected otherwise.

Created in NX8.5.0

License requirements: None.

Parameters
items
unsafe void NXOpen.BlockStyler.ListBox.SetSelectedItems ( int[]  selectedItems)
inline

Sets SelectedItems

Created in NX8.5.0

License requirements: None.

Parameters
selectedItemsselected items
unsafe void NXOpen.BlockStyler.ListBox.SetSelectedItemStrings ( string[]  strings)
inline

Sets the SelectedItemStrings.

Selects the list items based on input array of strings.

Created in NX8.5.0

License requirements: None.

Parameters
strings

Property Documentation

unsafe bool NXOpen.BlockStyler.ListBox.AllowDeselectForSingleSelect
getset

Returns or sets the AllowDeselectForSingleSelect.

Allows deselection of item using Ctrl+MB1 when single select is true.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.ListBox.Height
getset

Returns or sets the Height

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.ListBox.IsAddButtonSensitive
getset

Returns or sets the IsAddButtonSensitive

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.ListBox.IsDeleteButtonSensitive
getset

Returns or sets the IsDeleteButtonSensitive

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.ListBox.Localize
getset

Returns or sets the Localize.

If true, translates the Label string into the language of the current locale.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.ListBox.MaximumHeight
getset

Returns or sets the MaximumHeight

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.ListBox.MaximumStringLength
getset

Returns or sets the MaximumStringLength

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.ListBox.MinimumHeight
getset

Returns or sets the MinimumHeight

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.ListBox.ResizeHeightWithDialog
getset

Returns or sets the ResizeHeightWithDialog

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.ListBox.SelectedItemIndex
getset

Returns or sets the SelectedItemIndex.

Valid only if SingleSelect is true. Otherwise -1 is returned.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.ListBox.SelectedItemString
getset

Returns or sets the SelectedItemString.

Valid only if SingleSelect is true. Otherwise empty string is returned.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.ListBox.ShowAddButton
getset

Returns or sets the ShowAddButton.

If true, Add button is shown.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.ListBox.ShowDeleteButton
getset

Returns or sets the ShowDeleteButton.

If true, Delete button is shown.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.ListBox.ShowMoveUpDownButtons
getset

Returns or sets the ShowMoveUpDownButtons.

If true, MoveUp and MoveDown buttons are shown.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.ListBox.SingleSelect
getset

Returns or sets the SingleSelect.

If true, only single item can be selected.

Created in NX8.5.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.