Class pfcWindows

API Documentation > Collections > Class pfcWindows

Class pfcWindows

Description

This data type is used to specify an array of windows.

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

/* readonly */ number	Count


	Returns the number of items in the sequence.

Method Summary

void	Append ( pfcWindow Item )


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


	Removes all items from the sequence.
void	Insert ( number AtIndex , pfcWindow Item )


	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.
void	InsertSeq ( number AtIndex , pfcWindows Sequence )


	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.
pfcWindow	Item ( number Index )


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


	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.
void	Set ( number Index , pfcWindow Item )


	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

/* readonly */ number

Count

Returns the number of items in the sequence.

Method Detail

void

Append

( pfcWindow Item )

Adds a new item to the end of the sequence.

void

Clear

( )

Removes all items from the sequence.

void

Insert

( number AtIndex , pfcWindow Item )

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.

void

InsertSeq

( number AtIndex , pfcWindows Sequence )

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.

pfcWindow

Item

( number Index )

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

void

Remove

( number FromIndex , number ToIndex )

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.

void

Set

( number Index , pfcWindow Item )

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?