Class IpfcFamilyTableRows

API Documentation > Collections > Class IpfcFamilyTableRows

Description

This data type is used to specify a list of rows in a family table.

The user can access elements by their integer index (position) in the list. Sequence provides methods for positional (indexed) access to its elements. Sequences are zero based.

Property Summary

Property	Count	as Long [readonly]


	Returns the number of items in the sequence.

Method Summary

Sub	Append ( Item as IpfcFamilyTableRow )


	Adds a new item to the end of the sequence.
Sub	Clear ( )


	Removes all items from the sequence.
Sub	Insert ( AtIndex as Long , Item as IpfcFamilyTableRow )


	Inserts a new item in front of the sequence item with the specified index. If the index is out of range, the sequence is expanded to include this index.
Sub	InsertSeq ( AtIndex as Long , Sequence as IpfcFamilyTableRows )


	Inserts a sequence of items passed as the second argument in front of the sequence item with the specified index. If the index is out of range, the sequence is expanded to include this index.
Function	Item ( Index as Long )	as IpfcFamilyTableRow


	Accesses an item by its index in the sequence. If the index is out of range, this method throws the cipXInvalidSeqIndex exception.
Sub	Remove ( FromIndex as Long , ToIndex as Long )


	Removes items in the specified range from the sequence. The first argument specifies the index of the first item to be removed. The second argument specifies the index of the item immediately after the last in the range to be removed.
Sub	Set ( Index as Long , Item as IpfcFamilyTableRow )


	Assigns an item to the designated index in the sequence. If the index is out of range, the sequence is expanded to include this index.

Property Detail

Property

Count

as Long [readonly]

Returns the number of items in the sequence.

Method Detail

Sub

Append

( Item as IpfcFamilyTableRow )

Adds a new item to the end of the sequence.

Sub

Clear

( )

Removes all items from the sequence.

Sub

Insert

( AtIndex as Long , Item as IpfcFamilyTableRow )

Inserts a new item in front of the sequence item with the specified index. If the index is out of range, the sequence is expanded to include this index.

Sub

InsertSeq

( AtIndex as Long , Sequence as IpfcFamilyTableRows )

Inserts a sequence of items passed as the second argument in front of the sequence item with the specified index. If the index is out of range, the sequence is expanded to include this index.

Function

Item

( Index as Long )

as IpfcFamilyTableRow

Accesses an item by its index in the sequence. If the index is out of range, this method throws the cipXInvalidSeqIndex exception.

Sub

Remove

( FromIndex as Long , ToIndex as Long )

Removes items in the specified range from the sequence. The first argument specifies the index of the first item to be removed. The second argument specifies the index of the item immediately after the last in the range to be removed.

Sub

Set

( Index as Long , Item as IpfcFamilyTableRow )

Assigns an item to the designated index in the sequence. If the index is out of range, the sequence is expanded to include this index.

Was this helpful?