Files
kompas3d-mcp/docs/Kompas3D_SDK/interfaces/ksattributeparam.md
T
mikhail e1337e4016 feat(sdk-docs): MD-база знаний SDK — в репозиторий; генератор и зеркало убраны
docs/Kompas3D_SDK/ становится каноническим источником справки КОМПАС SDK
и включается в репозиторий (2491 файл, ~14 МБ). HTML-зеркало
docs/KOMPAS_SDK_ru-RU/ (~1.4 ГБ, © АСКОН) и генератор
tools/build_kompas3d_sdk.py больше не нужны — регенерация не предполагается.

- .gitignore: MD-база разблокирована; зеркало остаётся проигнорированным
  (safety-net на случай повторной локальной выгрузки).
- CLAUDE.md / SKILL.md: убраны упоминания регенерации и зеркала.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-26 20:00:05 +03:00

7.8 KiB
Raw Blame History

title, type, api, tags, sources
title type api tags sources
Табличный атрибут (Интерфейс ksAttributeParam) interface
api7
interface
api7
ksattributeparam
ksattributeparam.html

*API интерфейсов. Версия 5 > Интерфейсы работы с атрибутами  > Интерфейсы параметров атрибутов *

Табличный атрибут (Интерфейс ksAttributeParam)

Интерфейс параметров атрибута. Аналог данных параметров при использовании API экспортных функций - ksAttribute. Примечание:

  1. Перед использованием указатель на интерфейс должен быть определен с помощью метода KompasObject::GetParamStruct с параметром ko_Attribute.
  2. При создании типа атрибута ключам key1 - key4 могут быть присвоены нулевые значения. Если заданы ненулевые значения ключей или одного из ключей, эти значения могут быть использованы в дальнейшем как дополнительные идентификаторы для поиска атрибута с помощью итератора по атрибутам ksIterator::ksCreateAttrIterator. При присвоении значений ключам рекомендуется для ключей key1, key3 присваивать код, идентифицирующий разработчика, для ключа key2 - код атрибута, для ключа key4 - системный код. Значения параметра key4 от 0 до 1000 зарезервированы за ЗАО "АСКОН".
  3. Значения ключей атрибута могут быть получены с помощью метода ksAttributeObject::ksGetAttrKeysInfo. Смотрите также KompasObject

GetColumnKeys - Получить указатель на интерфейс динамического массива ключей колонок атрибута типа LTVARIANT_ARR - ksDynamicArray

Синтаксис Automation:

LPDISPATCH GetColumnKeys();
Возвращаемое значение:
- указатель на интерфейс динамического массива типа LTVARIANT_ARR ksDynamicArray.
Смотрите также ksLtVariant

GetFlagVisible - Получить указатель на интерфейс динамического массива типа LTVARIANT_ARR - ksDynamicArray

Синтаксис Automation:

LPDISPATCH GetFlagVisible();
Возвращаемое значение:
- указатель на интерфейс динамического массива типа LTVARIANT_ARR ksDynamicArray.

Примечание: Интерфейс динамического массива ksDynamicArray определяет для каждой колонки атрибута видимость-невидимость. Смотрите также ksLtVariant

GetValues - Получить указатель на интерфейс массива значений ячеек таблицы атрибутов ksUserParam

Синтаксис Automation:

LPDISPATCH GetValues();
Возвращаемое значение:
- указатель на интерфейс ksUserParam.

Init - Инициализировать параметры

Синтаксис Automation:

BOOL Init();
Возвращаемое значение:
TRUE    - в случае удачного завершения.

Примечания:

  1. Метод обнуляет все параметры.
  2. Динамические массивы не создаются.

Key1, key3 - Ключи атрибута

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

key1 = iAttributeTypeParam.key1    Получить свойство (* )
iAttributeTypeParam.key1 = key1    Установить свойство (* )
key1 = iAttributeTypeParam.GetKey1()    Получить свойство (**)
iAttributeTypeParam.SetKey1( key1 )    Установить свойство (**)

Примечание: Данные ключи рекомендуются как код разработчика.

Key2 - код атрибута key2

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

key2 = iAttributeTypeParam.key2    Получить свойство (* )
iAttributeTypeParam.key2 = key2    Установить свойство (* )
key2 = iAttributeTypeParam.GetKey2()    Получить свойство (**)
iAttributeTypeParam.SetKey2( key2 )    Установить свойство (**)

Key4 - Системный код атрибута

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

key4 = iAttributeTypeParam.key4    Получить свойство (* )
iAttributeTypeParam.key4 = key4    Установить свойство (* )
key4 = iAttributeTypeParam.GetKey4()    Получить свойство (**)
iAttributeTypeParam.SetKey4( key4 )    Установить свойство (**)

Примечание: Значения параметра key4 от 0 до 1000 зарезервированы за ЗАО "АСКОН".

Password - Пароль типа атрибута

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

password = iAttributeTypeParam.password    Получить свойство (* )
iAttributeTypeParam.password = password    Установить свойство (* )
password = iAttributeTypeParam.GetPassword()    Получить свойство (**)
iAttributeTypeParam.SetPassword( password )    Установить свойство (**)

Примечание: Если строка не пустая, то пароль защищает тип атрибута от несанкционированного изменения.

SetColumnKeys - Установить указатель на интерфейс динамического массива ключей колонок атрибута типа LTVARIANT_ARR - ksDynamicArray

Синтаксис Automation:

BOOL SetColumnKeys (LPDISPATCH value);
Входной параметр:
value    - указатель на интерфейс динамического массива типа LTVARIANT_ARR ksDynamicArray.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
Смотрите также ksLtVariant

SetFlagVisible - Установить указатель на интерфейс динамического массива типа LTVARIANT_ARR - ksDynamicArray

Синтаксис Automation:

BOOL SetFlagVisible (LPDISPATCH value);
Входной параметр:
value    - указатель на интерфейс динамического массива типа LTVARIANT_ARR ksDynamicArray.
Возвращаемое значение:
TRUE    - в случае удачного завершения.

Примечание: Интерфейс динамического массива ksDynamicArray определяет для каждой колонки атрибута видимость-невидимость. Смотрите также ksLtVariant

SetValues - Заполнить массив значений ячеек таблицы атрибутов ksUserParam

Синтаксис Automation:

BOOL SetValues (LPDISPATCH value);
Входной параметр:
value    - указатель на интерфейс массива значений ячеек таблицы атрибутов ksUserParam.
Возвращаемое значение:
TRUE    - в случае удачного завершения.