Интерфейс TreeItem

Объект TreeItem является элементом компонента TreeView. Подробнее...

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

Открытые члены

 Add ([in] BSTR Text,[in, defaultvalue(-1)] LONG ImageIndex,[in, defaultvalue(-1)] LONG SelectedImageIndex,[out, retval] IDispatch **pItem)
 Метод позволяет добавить новый дочерний элемент.
 Insert ([in] LONG Index,[in] BSTR Text,[in, defaultvalue(-1)] LONG ImageIndex,[in, defaultvalue(-1)] LONG SelectedImageIndex,[out, retval] IDispatch **pItem)
 Метод позволяет добавить новый дочерний элемент в нужную позицию.
 Remove ([in, defaultvalue(TREEVIEW_THISITEM)] LONG Index)
 Метод позволяет удалить элемент из коллекции.
 Clear ()
 Метод очищает коллекцию, удаляя все дочерние элементы.
 Expand ([in, defaultvalue(FALSE)] VARIANT_BOOL Recurse)
 Метод раскрывает поддерево дочерних элементов, также можно воспользоваться свойством Expanded.
 Collapse ()
 Метод сворачивает поддерево дочерних элементов, также можно воспользоваться свойством Expanded.
 EditLabel ()
 Метод позволяет редактировать текст элемента.
 Sort ([in, defaultvalue(TRUE)] VARIANT_BOOL Recurse)
 Метод сортирует дочерние элементы в алфавитном порядке.
 MakeVisible ()
 Метод делает элемент видимым, производя необходимое разворачивание и прокрутку.

Свойства

LPUNKNOWN R _NewEnum []
 Это свойство реализует функционирование объекта как коллекции, его не нужно вызывать напрямую.
VARIANT R Item [[in] long Index] []
 Свойство позволяет обратиться к элементам коллекции.
long R Count []
 Свойство позволяет получить количество элементов в коллекции.
BSTR RW Text []
 Свойство определяет текст элемента.
LONG RW ImageIndex []
 Свойство определяет индекс изображения элемента в списке изображений владельца.
LONG RW SelectedImageIndex []
 Свойство определяет индекс изображения элемента в списке изображений владельца, когда элемент находится в выделенном состоянии.
VARIANT_BOOL RW Selected []
 Свойство определяет выделен ли элемент.
VARIANT_BOOL RW Expanded []
 Свойство определяет развернуто ли поддерево дочерних элементов у данного узла.
VARIANT_BOOL RW Bold []
 Свойство определяет, выделен ли элемент полужирным щрифтом.
VARIANT_BOOL RW Checked []
 Свойство определяет состояние переключателя у элемента.
VARIANT_BOOL R HasChildren []
 Свойство определяет, имеет ли элемент дочерние элементы.
IDispatch *R Parent []
 Свойство позволяет обратиться к родительскому элементу.
IDispatch *R NextSibling []
 Свойство позволяет обратиться к следующему соседнему элементу.
IDispatch *R PrevSibling []
 Свойство позволяет обратиться к предыдущему соседнему элементу.
IDispatch *R FirstChild []
 Свойство позволяет обратиться к первому дочернему элементу.
IDispatch *R LastChild []
 Свойство позволяет обратиться к последнему дочернему элементу.
VARIANT RW UserData []
 Свойство UserData - некоторое значение, определяемое и используемое разработчиком в соответствии со своими желаниями.
BSTR RW Hint []
 Позволяет задать подсказку для элемента.
IDispatch *RW Font []
 Позволяет задать шрифт (Font) элемента.
ULONG RW TextBkColor []
 Позволяет задать цвет фона элемента.


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

Объект TreeItem является элементом компонента TreeView.

Объект является коллекцией таких же как он объектов TreeItem.


Методы

Add ( [in] BSTR  Text,
[in, defaultvalue(-1)] LONG  ImageIndex,
[in, defaultvalue(-1)] LONG  SelectedImageIndex,
[out, retval] IDispatch **  pItem 
)

Метод позволяет добавить новый дочерний элемент.

Аргументы:
Text текст нового элемента
ImageIndex индекс изображения нового элемента
SelectedImageIndex индекс изображения в выделенном состоянии нового элемента, если значение этого параметра "-1" то значение устанавливается равным значению параметра ImageIndex.
Возвращаемые значения:
pItem создаваемый элемент

Clear (  ) 

Метод очищает коллекцию, удаляя все дочерние элементы.

Collapse (  ) 

Метод сворачивает поддерево дочерних элементов, также можно воспользоваться свойством Expanded.

EditLabel (  ) 

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

Для редактирования отображается компонент редактирования текста. После редактирования вызываются обработчики события OnEdited.

Заметки:
Свойство ReadOnly владельца должно иметь значение "FALSE".

Expand ( [in, defaultvalue(FALSE)] VARIANT_BOOL  Recurse  ) 

Метод раскрывает поддерево дочерних элементов, также можно воспользоваться свойством Expanded.

Аргументы:
Recurse определяет раскрытие всего поддерева

Insert ( [in] LONG  Index,
[in] BSTR  Text,
[in, defaultvalue(-1)] LONG  ImageIndex,
[in, defaultvalue(-1)] LONG  SelectedImageIndex,
[out, retval] IDispatch **  pItem 
)

Метод позволяет добавить новый дочерний элемент в нужную позицию.

Аргументы:
Index позиция нового элемента
Text текст нового элемента
ImageIndex индекс изображения нового элемента
SelectedImageIndex индекс изображения в выделенном состоянии нового элемента, если значение этого параметра "-1" то значение устанавливается равным значению параметра ImageIndex.
Возвращаемые значения:
pItem создаваемый элемент

MakeVisible (  ) 

Метод делает элемент видимым, производя необходимое разворачивание и прокрутку.

Remove ( [in, defaultvalue(TREEVIEW_THISITEM)] LONG  Index  ) 

Метод позволяет удалить элемент из коллекции.

Аргументы:
Index определяет индекс элемента, если значение параметра TREEVIEW_THISITEM, то элемент удаляет себя.
Заметки:
Элемент удаляется вместе с дочерними элементами.

Sort ( [in, defaultvalue(TRUE)] VARIANT_BOOL  Recurse  ) 

Метод сортирует дочерние элементы в алфавитном порядке.

Аргументы:
Recurse параметр определяет рекурсивную сортировку всех элементов в дереве дочерних элементов


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

LPUNKNOWN R _NewEnum

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

VARIANT_BOOL RW Bold

Свойство определяет, выделен ли элемент полужирным щрифтом.

Значение по умолчанию: "FALSE".

Заметки:
Если шрифт компонента TreeView полужирный то свойство игнорируется.

VARIANT_BOOL RW Checked

Свойство определяет состояние переключателя у элемента.

Заметки:
Переключатели отображаются если свойство CheckBoxes имеет значение "TRUE".

long R Count

Свойство позволяет получить количество элементов в коллекции.

VARIANT_BOOL RW Expanded

Свойство определяет развернуто ли поддерево дочерних элементов у данного узла.

Перед развертыванием поддерева вызываются обработчики события OnEdited. После развертывания поддерева вызываются обработчики события OnEdited. Перед свертыванием поддерева вызываются обработчики события OnEdited. После свертывания поддерева вызываются обработчики события OnEdited.

IDispatch* R FirstChild

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

IDispatch* RW Font

Позволяет задать шрифт (Font) элемента.

Свойство CustomDraw родительского компонента TreeView должно быть "TRUE".

Начиная с:
1.1.12.

VARIANT_BOOL R HasChildren

Свойство определяет, имеет ли элемент дочерние элементы.

BSTR RW Hint

Позволяет задать подсказку для элемента.

InfoTip должно быть равно "TRUE".

Начиная с:
1.1.10.

LONG RW ImageIndex

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

VARIANT R Item[[in] long Index] (  ) 

Свойство позволяет обратиться к элементам коллекции.

Аргументы:
Index индекс элемента

IDispatch* R LastChild

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

IDispatch* R NextSibling

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

IDispatch* R Parent

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

IDispatch* R PrevSibling

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

VARIANT_BOOL RW Selected

Свойство определяет выделен ли элемент.

LONG RW SelectedImageIndex

Свойство определяет индекс изображения элемента в списке изображений владельца, когда элемент находится в выделенном состоянии.

BSTR RW Text

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

ULONG RW TextBkColor

Позволяет задать цвет фона элемента.

Свойство CustomDraw родительского компонента TreeView должно быть "TRUE".

Начиная с:
1.1.12.

VARIANT RW UserData

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


Документация по WSO 1.1. Последние изменения:Wed Aug 12 18:11:28 2015. (C) Веретенников А. Б. 2004-2015