cohtml.Net.ArrayInfo

Represents an array of a type exposed to the scripting.

Inherits from SystemIDisposable

Public Functions

	Name
virtual void	Dispose()
delegate ulong	LengthGetter(System.IntPtr arrayModelKey) Callback that returns the length of the array.
delegate System.IntPtr	ElementGetter(System.IntPtr arrayModelKey, System.UIntPtr index) A callback that returns the key of the nested object or the value of the element.
delegate void	ArrayElementBinder(System.IntPtr binderPtr, System.IntPtr arrayModelKey, System.UIntPtr index) Expose only the value of the property to the binder instance.
delegate void	ArrayElementReader(System.IntPtr binderPtr, System.IntPtr arrayModelKey, System.UIntPtr index) Sets the new value of the current model read from the binder.
void	SetCallbackGetLength(cohtml.Net.ArrayInfo.LengthGetter getLengthCallback) Set a callback that returns the length of the array in the Property.
void	SetCallbackGetElement(cohtml.Net.ArrayInfo.ElementGetter getElementCallback) Set a callback that returns an element from the array at a specific index in the property
void	SetCallbackBindElement(ArrayInfo.ArrayElementBinder bindElementCallback) Set a callback that binds an element from the array at a specific index in the property
	ArrayInfo()

Public Properties

	Name
ElementType	Type Type of the elements in the array.
global.System.IntPtr	ArrayTypeInfo Type information for elements when Type is ET_UserType; null otherwise.
global.System.IntPtr	UserData Pointer to the underlying array or container. May represent the actual container or an abstraction defined by the property implementation.

Protected Attributes

	Name
bool	swigCMemOwn

Public Functions Documentation

function Dispose

virtual void Dispose()

function LengthGetter

delegate ulong LengthGetter(
    System.IntPtr arrayModelKey
)

Callback that returns the length of the array.

Parameters:

• arrayModelKey The key associated with the registered array model.

Return: The size of the array.

function ElementGetter

delegate System.IntPtr ElementGetter(
    System.IntPtr arrayModelKey,
    System.UIntPtr index
)

A callback that returns the key of the nested object or the value of the element.

Parameters:

• arrayModelKey The key to the registered array.
• index The index of the searched element.

Return: The value of the element.

function ArrayElementBinder

delegate void ArrayElementBinder(
    System.IntPtr binderPtr,
    System.IntPtr arrayModelKey,
    System.UIntPtr index
)

Expose only the value of the property to the binder instance.

Parameters:

• binderPtr A pointer to the binder instanc.
• arrayModelKey The key to the registered array.
• index The index of the searched element.

function ArrayElementReader

delegate void ArrayElementReader(
    System.IntPtr binderPtr,
    System.IntPtr arrayModelKey,
    System.UIntPtr index
)

Sets the new value of the current model read from the binder.

Parameters:

• binderPtr A pointer to the binder instance.
• arrayModelKey The key to the registered array.
• index The index of the searched element.

function SetCallbackGetLength

void SetCallbackGetLength(
    cohtml.Net.ArrayInfo.LengthGetter getLengthCallback
)

Set a callback that returns the length of the array in the Property.

Parameters:

• getLengthCallback The callback to be registered.

function SetCallbackGetElement

void SetCallbackGetElement(
    cohtml.Net.ArrayInfo.ElementGetter getElementCallback
)

Set a callback that returns an element from the array at a specific index in the property

Parameters:

• getElementCallback - the callback to be registered.

function SetCallbackBindElement

void SetCallbackBindElement(
    ArrayInfo.ArrayElementBinder bindElementCallback
)

Set a callback that binds an element from the array at a specific index in the property

Parameters:

• bindElementCallback - the callback to be registered.

function ArrayInfo

ArrayInfo()

Public Property Documentation

property Type

ElementType Type;

Type of the elements in the array.

property ArrayTypeInfo

global.System.IntPtr ArrayTypeInfo;

Type information for elements when Type is ET_UserType; null otherwise.

property UserData

global.System.IntPtr UserData;

Pointer to the underlying array or container. May represent the actual container or an abstraction defined by the property implementation.

Protected Attributes Documentation

variable swigCMemOwn

bool swigCMemOwn;

---