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

title, type, api, tags, sources

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

*API интерфейсов. Версия 7 > Документ  > Свойства *

Интерфейс IFormatLabelRules

Интерфейс Правила формирования отображаемых имен объектов в дереве документа. Иерархия: IDispatch IKompasAPIObject IFormatLabelRules Описание:

1. Интерфейс позволяет сформировать правила формирования отображаемых имен объектов в дереве документа.
2. Интерфейс можно получить с помощью метода IDocumentSettings1::FormatLabelRules. Версия: Компас v20

AddProperty - Добавить свойство в список правил

Синтаксис Automation:

BOOL AddProperty( long IndexAt, IProperty * Property, BOOL Use, BSTR Prefix );

Синтаксис COM:

HRESULT AddProperty( long IndexAt, IProperty * Property, BOOL Use, BSTR Prefix, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
Входные параметры:
IndexAt    - индекс добавляемой настройки,
PropertyId    - указатель на интерфейс описания свойства IProperty,
Use    - признак использования,
Prefix    - префикс.

AddPropertyById - Добавить свойство по идентификатору в список правил

Синтаксис Automation:

BOOL AddPropertyById( long IndexAt, double PropertyId, BOOL Use, BSTR Prefix );

Синтаксис COM:

HRESULT AddPropertyById( long IndexAt, double PropertyId, BOOL Use, BSTR Prefix, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
Входные параметры:
IndexAt    - индекс добавляемой настройки,
PropertyId    - указатель на интерфейс описания свойства IProperty,
Use    - признак использования,
Prefix    - префикс.

AddPropertyFromLibrary - Добавить свойство из библиотеки в список правил

Синтаксис Automation:

BOOL AddPropertyFromLibrary( long IndexAt, BSTR FileName, double PropertyId, BOOL Use, BSTR Prefix );

Синтаксис COM:

HRESULT AddPropertyFromLibrary( long IndexAt, BSTR FileName, double PropertyId, BOOL Use, BSTR Prefix, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
Входные параметры:
IndexAt    - индекс добавляемой настройки,
FileName    - имя файла библиотеки,
PropertyId    - указатель на интерфейс описания свойства IProperty,
Use    - признак использования,
Prefix    - префикс.

Clear - Очистить список

Синтаксис Automation:

BOOL Clear();

Синтаксис COM:

HRESULT Clear( BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.

DeleteProperty - Удалить настройку для свойства по индексу

Синтаксис Automation:

BOOL DeleteProperty( long Index );

Синтаксис COM:

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

PropertiesCount - Количество свойств в настройках

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

PropertiesCount = Object.PropertiesCount    Получить свойство(* )
PropertiesCount = Object.GetPropertiesCount()    Получить свойство(**)

Синтаксис COM:

Object.get_PropertiesCount( &PropertiesCount )    Получить свойство.

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

Property - Описание свойства

Тип данных: Указатель на интерфейс IProperty. Синтаксис Automation:

Property = Object.Property( Index )    Получить свойство (* )
Object.Property( Index ) = Property    Установить свойство (* )
Property = Object.GetProperty( Index )    Получить свойство(**)
Object.SetProperty( Index, Property )    Установить свойство (**)

Синтаксис COM:

Object.get_Property( Index, &Property )    Получить свойство,
Object.put_Property( Index, Property )    Установить свойство.
Входные параметры:
long Index    - индекс свойства в списке правил.

PropertyId - Идентификатор свойства

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

PropertyId = Object.PropertyId( Index )    Получить свойство (* )
Object.PropertyId( Index ) = PropertyId    Установить свойство (* )
PropertyId = Object.GetPropertyId( Index )    Получить свойство(**)
Object.SetPropertyId( Index, PropertyId )    Установить свойство (**)

Синтаксис COM:

Object.get_PropertyId( Index, &PropertyId )    Получить свойство,
Object.put_PropertyId( Index, PropertyId )    Установить свойство.
Входные параметры:
long Index    - индекс свойства в списке правил.

PropertyPrefix - Cтрока, добавляемая перед значением свойства

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

PropertyPrefix = Object.PropertyPrefix( Index )    Получить свойство (* )
Object.PropertyPrefix( Index ) = PropertyPrefix    Установить свойство (* )
PropertyPrefix = Object.GetPropertyPrefix( Index )    Получить свойство(**)
Object.SetPropertyPrefix( Index, PropertyPrefix )    Установить свойство (**)

Синтаксис COM:

Object.get_PropertyPrefix( Index, &PropertyPrefix )    Получить свойство,
Object.put_PropertyPrefix( Index, PropertyPrefix )    Установить свойство.
Входные параметры:
long Index    - индекс свойства в списке правил.

PropertyUse - Признак использования свойства

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

PropertyUse = Object.PropertyUse( Index )    Получить свойство (* )
Object.PropertyUse( Index ) = PropertyUse    Установить свойство (* )
PropertyUse = Object.GetPropertyUse( Index )    Получить свойство(**)
Object.SetPropertyUse( Index, PropertyUse )    Установить свойство (**)

Синтаксис COM:

Object.get_PropertyUse( Index, &PropertyUse )    Получить свойство,
Object.put_PropertyUse( Index, PropertyUse )    Установить свойство.
Входные параметры:
long Index    - индекс свойства в списке правил.

SwapProperties - Поменять свойства местами

Синтаксис Automation:

BOOL SwapProperties( long Index1, long Index2 );

Синтаксис COM:

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