Интерфейс StringsControl

Класс StringsControl является базовым классом для компонентов, являющихся наборами строк текста. Подробнее...

Граф наследования:StringsControl:

Граф связей класса StringsControl:

Полный список членов класса

Открытые члены
	Add ([in] BSTR Item,[out, retval] LONG *pItemIndex)
	Метод добавляет в список строку.
	Remove ([in] LONG Index)
	Метод удаляет из списка строку.
	Insert ([in] LONG Index,[in] BSTR Item,[out, retval] LONG *pItemIndex)
	Метод добавляет в список строку в указанную позицию.
	Clear (void)
	Метод очищает список строк, удаляя все строки.
	BeginUpdate ()
	Метод запрещает обновление внешнего вида компонента при изменении набора строк, метод полезно вызывать при добавлении большого количества строк.
	EndUpdate ()
	Метод разрешает обновление внешнего вида компонента при изменении набора строк, его следует вызывать после метода BeginUpdate.
	ExChange ([in] LONG A,[in] LONG B)
	Метод меняет местами элементы в коллекции.
	Sort ([in, defaultvalue(DT_STRING)] LONG DataType,[in, defaultvalue(FALSE)] VARIANT_BOOL Reverse)
	Метод сортирует строки.
	Find ([in] BSTR Text,[in, defaultvalue(0)] LONG Start,[in, defaultvalue(TRUE)] VARIANT_BOOL IgnoreCase,[out, retval] LONG *pItemIndex)
	Метод позволяет определить наличие в списке строк определенной строки.
Свойства
LONG RW	TopIndex []
	Свойство определяет номер самой верхней видимой строки.
LPUNKNOWN R	_NewEnum []
	Это свойство реализует функционирование объекта как коллекции, его не нужно вызывать напрямую.
BSTR RW	Item [[in] long Index] []
	Свойство позволяет обратиться к нужной строке по ее индексу.
long R	Count []
	Свойство позволяет узнать количество строк, находящихся в компоненте.

---

Подробное описание

Класс StringsControl является базовым классом для компонентов, являющихся наборами строк текста.

---

Методы

Add	(	[in] BSTR	Item,
		[out, retval] LONG *	pItemIndex
	)

Метод добавляет в список строку.

Аргументы:

Item

добавляемая строка

Возвращаемые значения:

pItemIndex

индекс добавленной строки

BeginUpdate

(

)

Метод запрещает обновление внешнего вида компонента при изменении набора строк, метод полезно вызывать при добавлении большого количества строк.

Заметки:

В последствие необходимо вызвать метод EndUpdate.

Clear

(

void

)

Метод очищает список строк, удаляя все строки.

EndUpdate

(

)

Метод разрешает обновление внешнего вида компонента при изменении набора строк, его следует вызывать после метода BeginUpdate.

Заметки:

Метод обновляет внешний вид компонента в случае изменения набора строк после вызова метода BeginUpdate.

ExChange	(	[in] LONG	A,
		[in] LONG	B
	)

Метод меняет местами элементы в коллекции.

Аргументы:

	A	определяет первый элемент
	B	определяет второй элемент

Find	(	[in] BSTR	Text,
		[in, defaultvalue(0)] LONG	Start,
		[in, defaultvalue(TRUE)] VARIANT_BOOL	IgnoreCase,
		[out, retval] LONG *	pItemIndex
	)

Метод позволяет определить наличие в списке строк определенной строки.

Аргументы:

	Text	искомая строка
	Start	начальная позиция поиска
	IgnoreCase	параметр определяет игнорирование регистра символов при поиске

Возвращаемые значения:

pItemIndex

индекс найденной строки в случае нахождения ее в списке, -1 если данной строки в списке нет, начиная с указанной позиции.

Insert	(	[in] LONG	Index,
		[in] BSTR	Item,
		[out, retval] LONG *	pItemIndex
	)

Метод добавляет в список строку в указанную позицию.

Аргументы:

	Index	индекс, который должен быть у добавленной строки, -1 означает добавление в конец списка
	Item	добавляемая строка

Возвращаемые значения:

pItemIndex

индекс добавленной строки

Remove

(

[in] LONG

Index

)

Метод удаляет из списка строку.

Аргументы:

Index

индекс удаляемой строки

Sort	(	[in, defaultvalue(DT_STRING)] LONG	DataType,
		[in, defaultvalue(FALSE)] VARIANT_BOOL	Reverse
	)

Метод сортирует строки.

Аргументы:

	DataType	тип данных, в соответствии с которым осуществляется сортировка
	Reverse	параметр определяет направление сортировки, значение "FALSE" соответствует сортировке по возрастанию, "TRUE" - по убыванию.

Заметки:

При вызове метода отменяется автоматическая сортировка компонентов, порожденных от класса ListControl.

---

Полный список свойств

LPUNKNOWN R _NewEnum

Это свойство реализует функционирование объекта как коллекции, его не нужно вызывать напрямую.

long R Count

Свойство позволяет узнать количество строк, находящихся в компоненте.

BSTR RW Item[[in] long Index]

(

)

Свойство позволяет обратиться к нужной строке по ее индексу.

LONG RW TopIndex

Свойство определяет номер самой верхней видимой строки.

---