NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::UIStyler::StylerItem Class Reference

Represents a Styler Item
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::UIStyler::StylerItem:
NXOpen::TransientObject NXOpen::UIStyler::BitMap NXOpen::UIStyler::ButtonLayout NXOpen::UIStyler::CollapsibleGroup NXOpen::UIStyler::ColorTool NXOpen::UIStyler::DialogItem NXOpen::UIStyler::GroupBox NXOpen::UIStyler::IntegerItem NXOpen::UIStyler::IntegerScale NXOpen::UIStyler::LabelItem NXOpen::UIStyler::MultiSelectList NXOpen::UIStyler::MultiTextBox NXOpen::UIStyler::OptionMenu NXOpen::UIStyler::OptionToggle NXOpen::UIStyler::PropertyPage NXOpen::UIStyler::PushButton NXOpen::UIStyler::RadioBox NXOpen::UIStyler::RealItem NXOpen::UIStyler::RealScale NXOpen::UIStyler::RowColumn NXOpen::UIStyler::ScrolledWindow NXOpen::UIStyler::SelectionBox NXOpen::UIStyler::Separator NXOpen::UIStyler::SingleSelectList NXOpen::UIStyler::StringItem NXOpen::UIStyler::TabControl NXOpen::UIStyler::Toggle NXOpen::UIStyler::ToolPalette NXOpen::UIStyler::WideString

Public Types

enum  ItemType {
  ItemTypeInvalidType = -1, ItemTypeActionButton, ItemTypeDialog, ItemTypeRadioBox,
  ItemTypeReal, ItemTypeScaleReal, ItemTypeBitmap, ItemTypeRowColumn,
  ItemTypeButtonLayout, ItemTypeScrolledWindow, ItemTypeColorTool, ItemTypeSelectionBox,
  ItemTypeSeparator, ItemTypeSingleSelectionList, ItemTypeString, ItemTypeBeginGroup,
  ItemTypeInteger, ItemTypeScaleInteger, ItemTypeMultiList, ItemTypeLabel,
  ItemTypeMultiLineText, ItemTypeTabControl, ItemTypeOptionMenu, ItemTypeToggle,
  ItemTypeOptionToggle, ItemTypeToolPalette, ItemTypeWideString, ItemTypePropertyPage,
  ItemTypeCollapsibleGroup
}
 Describes kind of action to be taken from callbac. More...
 

Public Member Functions

NXOpen::UIStyler::StylerItem::ItemType GetItemType ()
 Gets the dialog item type. More...
 
NXOpen::UIStyler::AttachmentInitializeAttachment ()
 Returns initialized dialog item attachment information. More...
 
bool IsEqualTo (NXOpen::UIStyler::StylerItem *itemToCompare)
 Equates two styler items. More...
 
void SetAttachment (NXOpen::UIStyler::Attachment *attachment)
 Specifies the updated dialog item attachment information
Created in NX5.0.0. More...
 
virtual ~StylerItem ()
 Free resources associated with the instance. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents a Styler Item
Created in NX5.0.0.


Member Enumeration Documentation

Describes kind of action to be taken from callbac.

Enumerator
ItemTypeInvalidType 

Invalid item.

ItemTypeActionButton 

Action Button item.

ItemTypeDialog 

Dialog item.

ItemTypeRadioBox 

Radio Box item.

ItemTypeReal 

Real item.

ItemTypeScaleReal 

Real Scale item.

ItemTypeBitmap 

Bitmap item.

ItemTypeRowColumn 

Row Column item.

ItemTypeButtonLayout 

Button Layout item.

ItemTypeScrolledWindow 

Scrolled Window item.

ItemTypeColorTool 

Color Item.

ItemTypeSelectionBox 

Section Box item.

ItemTypeSeparator 

Separator item.

ItemTypeSingleSelectionList 

Single Selection List item.

ItemTypeString 

String item.

ItemTypeBeginGroup 

Begin Group item.

ItemTypeInteger 

Integer item.

ItemTypeScaleInteger 

Scale item.

ItemTypeMultiList 

Multi List item.

ItemTypeLabel 

Label item.

ItemTypeMultiLineText 

Multi-line text item.

ItemTypeTabControl 

Tab Control item.

ItemTypeOptionMenu 

Option Menu item.

ItemTypeToggle 

Toggle item.

ItemTypeOptionToggle 

Option Toggle item.

ItemTypeToolPalette 

Tool Palette item.

ItemTypeWideString 

Wide String item.

ItemTypePropertyPage 

Property Page item.

ItemTypeCollapsibleGroup 

Callapsible Group item.

Constructor & Destructor Documentation

virtual NXOpen::UIStyler::StylerItem::~StylerItem ( )
virtual

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

Member Function Documentation

NXOpen::UIStyler::StylerItem::ItemType NXOpen::UIStyler::StylerItem::GetItemType ( )

Gets the dialog item type.

User can write programs to query this attribute and determine the type of a dialog item in order to determine what further actions should be taken.

Returns

Created in NX5.0.0.

License requirements : None
NXOpen::UIStyler::Attachment* NXOpen::UIStyler::StylerItem::InitializeAttachment ( )

Returns initialized dialog item attachment information.

Returns
attachment object
Created in NX5.0.0.

License requirements : None
bool NXOpen::UIStyler::StylerItem::IsEqualTo ( NXOpen::UIStyler::StylerItem itemToCompare)

Equates two styler items.

Returns

Created in NX5.0.0.

License requirements : None
Parameters
itemToComparestyler item to compare
void NXOpen::UIStyler::StylerItem::SetAttachment ( NXOpen::UIStyler::Attachment attachment)

Specifies the updated dialog item attachment information
Created in NX5.0.0.



License requirements : None

Parameters
attachmentattachment object

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