kompas3d-mcp/docs/Kompas3D_SDK/interfaces/ipropertyeditlist.md

title, type, api, tags, sources

title	type	api	tags	sources
Интерфейс IPropertyEditList	interface	api7	interface api7 ipropertyeditlist	ipropertyeditlist.html

*API интерфейсов. Версия 7 > Приложение > Работа с Панелью свойств  > Интерфейс IPropertyControl  > IPropertyControl - свойства *

Интерфейс IPropertyEditList

Интерфейс элемента управления Панели свойств Список.

Элемент панели свойств
Иерархия:
IKompasAPIObject
IPropertyControl
IPropertyEditList
IPropertyToolBar
Описание:
Позволяет управлять списком из Панели свойств.
Примечание:

1. Данный интерфейс может быть получен от интерфейса коллекции элементов управления IPropertyControls с помощью свойства IPropertyControls::Item или метода IPropertyControls::Add с последующим приведением интерфейса IPropertyControl к данному интерфейсу с помощью метода IUnknown::QueryInterface.
2. Посредством вызова метода IUnknown::QueryInterface (const GUID far& iid, void** pif) у данного интерфейса можно получить дополнительный интерфейс вида IPropertyToolBar.

Add - Добавить значение в список

Синтаксис Automation:

void Add( LPCTSTR NewVal );

Синтаксис COM:

HRESULT Add( BSTR NewVal );
Входные параметры:
NewVal    - добавляемое значение.

AllowDelete - Разрешить удалять элементы из списка

Тип данных: BOOL Синтаксис Automation:

AllowDelete = Object.AllowDelete    Получить свойство (* )
Object.AllowDelete = AllowDelete    Установить свойство (* )
AllowDelete = Object.GetAllowDelete()    Получить свойство (**)
Object.SetAllowDelete( AllowDelete )    Установить свойство (**)

Синтаксис COM:

Object.get_AllowDelete( &AllowDelete )    Получить свойство
Object.put_AllowDelete( AllowDelete )    Установить свойство

BeginEditItem - Запустить редактирование значения в списке

Синтаксис Automation:

BOOL BeginEditItem( long Index );

Синтаксис COM:

HRESULT BeginEditItem( long Index, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
Входные параметры:
index    - индекс значения.

BringIntoView - Подкрутка к строке

Синтаксис Automation:

void BringIntoView( long Index );

Синтаксис COM:

HRESULT BringIntoView( long Index );
Входные параметры:
index    - индекс строки.
Версия: Компас v20

CheckState - Состояние контрола. Текущий, Не текущий

Тип данных: из перечисления CheckStateEnum Синтаксис Automation:

CheckState = Object.CheckState    Получить свойство (* )
Object.CheckState = CheckState    Установить свойство (* )
CheckState = Object.GetCheckState()    Получить свойство (**)
Object.SetCheckState( CheckState )    Установить свойство (**)

Синтаксис COM:

Object.get_CheckState( &CheckState )    Получить свойство
Object.put_CheckState( CheckState )    Установить свойство

ClearList - Очистить список значений

Синтаксис Automation:

void ClearList();

Синтаксис COM:

HRESULT ClearList();

ComputeUniqueNames - Генерация уникальных имен элементов

Тип данных: BOOL Синтаксис Automation:

ComputeUniqueNames = Object.ComputeUniqueNames    Получить свойство (* )
Object.ComputeUniqueNames = ComputeUniqueNames    Установить свойство (* )
ComputeUniqueNames = Object.GetComputeUniqueNames()    Получить свойство (**)
Object.SetComputeUniqueNames(ComputeUniqueNames)    Установить свойство (**)

Синтаксис COM:

Object.get_ComputeUniqueNames( &ComputeUniqueNames )    Получить свойство
Object.put_ComputeUniqueNames( ComputeUniqueNames )    Установить свойство
TRUE - автоматически нумеровать одноименные элементы в списке.

DefaultValue - Значение по умолчанию

Тип данных: BSTR Синтаксис Automation:

DefaultValue = Object.DefaultValue    Получить свойство (* )
Object.DefaultValue = DefaultValue    Установить свойство (* )
DefaultValue = Object.GetDefaultValue()    Получить свойство (**)
Object.SetDefaultValue( DefaultValue )    Установить свойство (**)

Синтаксис COM:

Object.get_DefaultValue( &DefaultValue )    Получить свойство
Object.put_DefaultValue(DefaultValue)    Установить свойство

Примечание Свойство задает строку- приглашение, отображаемую при незаполненном списке значений.

Delete - Удалить элемент из списка по значению или индексу

Синтаксис Automation:

void Delete (VARIANT Index);

Синтаксис COM:

HRESULT Delete (VARIANT Index);
Входные параметры:
index    - элемент из списка; значение элемента - строка или индекс элемента типа long.

Find - Найти индекс в списке по значению

Синтаксис Automation:

long Find( VARIANT Val );

Синтаксис COM:

HRESULT Find( VARIANT Val, long * Result );
Возвращаемое значение:
- индекс искомого значения.
Входные параметры:
Val    - искомое значение.

ItemChecked - Состояние элемента списка

Тип данных: BOOL. Синтаксис Automation:

BOOL ItemChecked = iObject.ItemChecked(index)    Получить свойство (* )
iObject.ItemChecked(index) = ItemChecked    Установить свойство (* )
BOOL ItemChecked = iObject.GetItemChecked(index)    Получить свойство(**)
iObject.SetItemChecked( index, ItemChecked )    Установить свойство (**)

Синтаксис COM:

iObject->get_ItemChecked( index, &ItemChecked )    Получить свойство
iObject->put_ItemChecked( index, ItemChecked )    Установить свойство
Входные параметры:
index    - индекс элемента списка.

ItemMissing - Потерянный объект

Тип данных: BOOL Синтаксис Automation:

ItemMissing = Object.ItemMissing( Index )    Получить свойство (* )
Object.ItemMissing( Index ) = ItemMissing    Установить свойство (* )
ItemMissing = Object.GetItemMissing( Index )    Получить свойство (**)
Object.SetItemMissing( Index, ItemMissing )    Установить свойство (**)

Синтаксис COM:

Object.get_ItemMissing( Index, &ItemMissing )    Получить свойство
Object.put_ItemMissing( Index, ItemMissing )    Установить свойство
Входные параметры:
Index    - индекс значения.

ItemsCount - Количество элементов в списке

Тип данных: long Синтаксис Automation:

long ItemsCount = iObject.ItemsCount    Получить свойство (* )
long ItemsCount = iObject.GetItemsCount()    Получить свойство(**)

Синтаксис COM:

iObject->get_ItemsCount( &ItemsCount )    Получить свойство

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

ItemSelected - Состояние выделенности элемента списка

Тип данных: long Синтаксис Automation:

long ItemSelected = iObject.ItemSelected    Получить свойство (* )
iObject.ItemSelected = ItemSelected    Установить свойство (* )
long ItemSelected = iObject.GetItemSelected()    Получить свойство(**)
iObject.SetItemSelected (ItemSelected)    Установить свойство (**)

Синтаксис COM:

iObject->get_ItemSelected (&ItemSelected)    Получить свойство
iObject->put_ItemSelected (ItemSelected)    Установить свойство

ItemValue - Значение элемента списка по индексу

Синтаксис Automation:

Тип данных: LPSTR.
ItemValue = iObject.ItemValue( Index )    Получить свойство (* )
iObject.ItemValue( Index ) = ItemValue    Установить свойство (* )
ItemValue = iObject.GetItemValue( Index )    Получить свойство(**)
iObject.SetItemValue( Index )    Установить свойство (**)

Синтаксис COM:

Тип данных:BSTR.
iObject->get_Name ( Index )    Получить свойство
iObject->put_Name ( Index )    Установить свойство
Входные параметры:
Index    - индекс элемента.

ListType - Тип списка

Тип данных: из перечисления ksEditListTypeEnum. Синтаксис Automation:

ksEditListTypeEnum ListType = iObject.ListType    Получить свойство (* )
iObject.ListType = ListType    Установить свойство (* )
ksEditListTypeEnum ListType = iObject.GetListType()    Получить свойство(**)
iObject.SetListType (ListType)    Установить свойство (**)

Синтаксис COM:

iObject->get_ListType (&ListType)    Получить свойство
iObject->put_ListType (ListType)    Установить свойство

MultySelect - Возможность множественного выделения

Тип данных: BOOL Синтаксис Automation:

BOOL MultySelect = iObject.MultySelect    Получить свойство (* )
iObject.MultySelect = MultySelect    Установить свойство (* )
BOOL MultySelect = iObject.GetMultySelect()    Получить свойство(**)
iObject.SetMultySelect (MultySelect)    Установить свойство (**)

Синтаксис COM:

iObject->get_MultySelect (&MultySelect)    Получить свойство
iObject->put_MultySelect (MultySelect)    Установить свойство

Sort - Состояние сортированности списка

Тип данных:BOOL. Синтаксис Automation:

BOOL Sort = iObject.Sort    Получить свойство (* )
iObject.Sort = Sort    Установить свойство (* )
BOOL Sort = iObject.GetSort()    Получить свойство(**)
iObject.SetSort (Sort)    Установить свойство (**)

Синтаксис COM:

iObject->get_Sort (&Sort)    Получить свойство
iObject->put_Sort (Sort)    Установить свойство