Class SimplePropIterator
Object to iterate over properties in inspector. It also inherits from IST_CustomPropIterator, because we create it from extension manager
Inheritance
Namespace: CAMAPI.UIDialogs.DotnetHelper
Assembly: CAMAPI.UIDialogs.DotnetHelper.dll
Syntax
public class SimplePropIterator : Object, IST_SimplePropIterator, IDisposable
Constructors
SimplePropIterator()
External constructor, used to create new object
Declaration
public SimplePropIterator()
Properties
Iterator
Object we are wrapping
Declaration
public ComWrapper<IST_SimplePropIterator> Iterator { get; }
Property Value
Type | Description |
---|---|
ComWrapper<IST_SimplePropIterator> |
Methods
AddBooleanProp(string, OnGetBooleanValue, OnSetBooleanValue)
Add child boolean property to inspector
Declaration
public SimplePropIterator AddBooleanProp(string caption, OnGetBooleanValue onGetBooleanValue, OnSetBooleanValue onSetBooleanValue)
Parameters
Type | Name | Description |
---|---|---|
string | caption | |
OnGetBooleanValue | onGetBooleanValue | |
OnSetBooleanValue | onSetBooleanValue |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
AddComplexProp(string)
Add empty property to inspector, which will be group for other properties
Declaration
public SimplePropIterator AddComplexProp(string caption)
Parameters
Type | Name | Description |
---|---|---|
string | caption |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
AddDoubleProp(string, OnGetDoubleValue, OnSetDoubleValue)
Add child double property to inspector
Declaration
public SimplePropIterator AddDoubleProp(string caption, OnGetDoubleValue onGetDoubleValue, OnSetDoubleValue onSetDoubleValue)
Parameters
Type | Name | Description |
---|---|---|
string | caption | |
OnGetDoubleValue | onGetDoubleValue | |
OnSetDoubleValue | onSetDoubleValue |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
AddEnumIdProp(string, OnGetStringValue, OnSetStringValue, GetEnumValues)
Add enum property to inspector, where chosen value return specified value. Values don't have icons
Declaration
public SimplePropIterator AddEnumIdProp(string caption, OnGetStringValue onGetStringValue, OnSetStringValue onSetStringValue, GetEnumValues getValues)
Parameters
Type | Name | Description |
---|---|---|
string | caption | Caption of the property |
OnGetStringValue | onGetStringValue | Delegate to get choosen value |
OnSetStringValue | onSetStringValue | Delegate to set choosen value |
GetEnumValues | getValues | Delegate to get gist of values to add |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
AddEnumIdProp(string, OnGetStringValue, OnSetStringValue, params KeyValuePair<string, string>[])
Add enum property to inspector, where chosen value return specified value. Values don't have icons
Declaration
public SimplePropIterator AddEnumIdProp(string caption, OnGetStringValue onGetStringValue, OnSetStringValue onSetStringValue, params KeyValuePair<string, string>[] values)
Parameters
Type | Name | Description |
---|---|---|
string | caption | Caption of the property |
OnGetStringValue | onGetStringValue | Delegate to get choosen value |
OnSetStringValue | onSetStringValue | Delegate to set choosen value |
KeyValuePair<string, string>[] | values | Values to add (key - stored, value - caption) |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
AddEnumIndexedProp(string, OnGetIntegerValue, OnSetIntegerValue, GetEnumIndexedValues)
Add enum property to inspector, where chosen value returns its index. Values have icons
Declaration
public SimplePropIterator AddEnumIndexedProp(string caption, OnGetIntegerValue onGetIntegerValue, OnSetIntegerValue onSetIntegerValue, GetEnumIndexedValues getValues)
Parameters
Type | Name | Description |
---|---|---|
string | caption | Caption of the property |
OnGetIntegerValue | onGetIntegerValue | Delegate to get integer value |
OnSetIntegerValue | onSetIntegerValue | Delegate to set integer value |
GetEnumIndexedValues | getValues | Delegate to get gist of values to add |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
AddEnumIndexedProp(string, OnGetIntegerValue, OnSetIntegerValue, params string[])
Add enum property to inspector, where chosen value returns its index. Values have icons
Declaration
public SimplePropIterator AddEnumIndexedProp(string caption, OnGetIntegerValue onGetIntegerValue, OnSetIntegerValue onSetIntegerValue, params string[] values)
Parameters
Type | Name | Description |
---|---|---|
string | caption | Caption of the property |
OnGetIntegerValue | onGetIntegerValue | Delegate to get integer value |
OnSetIntegerValue | onSetIntegerValue | Delegate to set integer value |
string[] | values | Values to add |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
AddIntegerProp(string, OnGetIntegerValue, OnSetIntegerValue)
Add child double property to inspector
Declaration
public SimplePropIterator AddIntegerProp(string caption, OnGetIntegerValue onGetIntegerValue, OnSetIntegerValue onSetIntegerValue)
Parameters
Type | Name | Description |
---|---|---|
string | caption | |
OnGetIntegerValue | onGetIntegerValue | |
OnSetIntegerValue | onSetIntegerValue |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
AddNewProp(IST_CustomProp, int)
Add child property to inspector, if it was created outside of this class
Declaration
public int AddNewProp(IST_CustomProp property, int parentIndex)
Parameters
Type | Name | Description |
---|---|---|
IST_CustomProp | property | |
int | parentIndex |
Returns
Type | Description |
---|---|
int |
AddStringProp(string, OnGetStringValue, OnSetStringValue)
Add child string property to inspector
Declaration
public SimplePropIterator AddStringProp(string caption, OnGetStringValue onGetStringValue, OnSetStringValue onSetStringValue)
Parameters
Type | Name | Description |
---|---|---|
string | caption | |
OnGetStringValue | onGetStringValue | |
OnSetStringValue | onSetStringValue |
Returns
Type | Description |
---|---|
SimplePropIterator | Index of item, injected into inspector |
Dispose()
Release COM objects
Declaration
public void Dispose()
MoveToRoot()
Declaration
public bool MoveToRoot()
Returns
Type | Description |
---|---|
bool |