pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
X3g::Plugin::ChoicePropertyValue Class Reference

Choice Property Value. More...

Inheritance diagram for X3g::Plugin::ChoicePropertyValue:
Inheritance graph
[legend]

Public Member Functions

 ChoicePropertyValue (System::String^ pKey)
 Constructor. More...
 
 ChoicePropertyValue (System::String^ pKey, System::String^ pText)
 Constructor. More...
 
 ChoicePropertyValue (System::String^ pKey, System::String^ pText, System::String^ pSmallImage, System::String^ pLargeImage, ChoiceValueType pValueType)
 Constructor. More...
 

Properties

System::String^  Key [get, set]
 The key of the choice item. More...
 
System::String^  Text [get]
 The text of the choice item. More...
 
System::String^  SmallImage [get]
 Path to a small icon image. More...
 
System::String^  LargeImage [get]
 Path to a large icon image. More...
 
ChoiceValueType ChoiceType [get]
 The type of the choice value. More...
 
- Properties inherited from X3g::Plugin::PropertyValue
PropertyType Type [get]
 The type of the value. More...
 
String^  ValueAsString [get, set]
 The string representation of the value. More...
 

Detailed Description

Choice Property Value.

Constructor & Destructor Documentation

X3g::Plugin::ChoicePropertyValue::ChoicePropertyValue ( System::String^  pKey)

Constructor.

Parameters
pKeySet the key of the choice item.
X3g::Plugin::ChoicePropertyValue::ChoicePropertyValue ( System::String^  pKey,
System::String^  pText 
)

Constructor.

Parameters
pKeySet the key of the choice item.
pTextSet the text of the choice item.
X3g::Plugin::ChoicePropertyValue::ChoicePropertyValue ( System::String^  pKey,
System::String^  pText,
System::String^  pSmallImage,
System::String^  pLargeImage,
ChoiceValueType  pValueType 
)

Constructor.

Parameters
pKeySet the key of the choice item.
pTextSet the text of the choice item.
pSmallImagePath to a small icon image.
pLargeImagePath to a large icon image.
pValueTypeThe type of the choice value. See ChoiceType.

Property Documentation

ChoiceValueType X3g::Plugin::ChoicePropertyValue::ChoiceType
get

The type of the choice value.

Can be used to generate a formated display value. It has no effect on the internal representation.

System:: String^ X3g::Plugin::ChoicePropertyValue::Key
getset

The key of the choice item.

System:: String^ X3g::Plugin::ChoicePropertyValue::LargeImage
get

Path to a large icon image.

System:: String^ X3g::Plugin::ChoicePropertyValue::SmallImage
get

Path to a small icon image.

System:: String^ X3g::Plugin::ChoicePropertyValue::Text
get

The text of the choice item.