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

title, type, api, domain, tags, sources

title	type	api	domain	tags	sources
Размерная надпись (Интерфейс ksDimTextParam)	interface	api7	2d	interface api7 2d ksdimtextparam	ksdimtextparam.html

*API интерфейсов. Версия 5 > Графический документ (Интерфейсы - ksDocument2D и IDocument2D)  > Интерфейсы параметров размеров *

Размерная надпись (Интерфейс ksDimTextParam)

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

1. Строки в массив ложатся в следующей последовательности: Префикс. Если он добавлен, в bitFlag взводится признак _PREFIX, Номинальное значение зависит от флагов _AUTONOMINAL и _NOMINALOFF. Номинальное значение добавляется, если _AUTONOMINAL и _NOMINALOFF выключены. Квалитет _TOLERANCE. Верхнее и нижнее отклонения _DEVIATION и _DEVIATION_INFORM. Единицы измерения _UNIT. Текст после _SUFFIX. Остальные строки это текст после.
2. Если флаг TOLERANCE включен, то значения отклонений не устанавливаются независимо от наличия их в массиве. Они воспринимаются как информационные.
3. Перед вызовом GetObjParam нужно установить stringFlag в 0, если нужно получить массив строк символов CHAR_STR_ARR, или в 1, если нужно получить массив текстов TEXT_LINE_ARR. Для того, чтобы добавить верхнее и нижнее отклонение, нужно рассчитать индекс с учетом включенных или выключенных флагов _PREFIX, _AUTONOMINAL, _NOMINALOFF, и TOLERANCE. Также нужно проверить, включен уже флаг _DEVIATION или нет. Если включен TOLERANCE, данный элемент нужно будет удалить.
4. Динамический массив TEXT_LINE_ARR содержит структуру TextLineParam. Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct. Смотрите также: KompasObject

bitFlag - Признак, определяющий ручное задание размерной надписи или набор битовых полей, задающих признаки размерной надписи

Тип данных:long. Значения свойства:

0	- ручное задание размерной надписи,
>0	- набор битовых полей, задающих признаки размерной надписи.
Синтаксис Automation:

bitFlag = iDimText.bitFlag    Получить свойство (* )
iDimText.bitFlag = bitFlag    Установить свойство (* )
bitFlag = iDimText.GetBitFlag()    Получить свойство (**)
iDimText.SetBitFlag( bitFlag )    Установить свойство (**)

GetBitFlagValue - Получить значение одного из флагов признака bitFlag

Синтаксис Automation:

BOOL GetBitFlagValue (long bitFlag);
Входной параметр:
bitFlag    - битовый флаг, характеризующий определенный признак размерной надписи.
Возвращаемое значение:
TRUE    - данный битовый флаг включен,
FALSE    - данный битовый флаг выключен.
См. также свойство bitFlag

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

Синтаксис Automation:

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

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

Синтаксис Automation:

BOOL Init(BOOL stringFlag);
Входной параметр:
stringFlag    - признак типа создаваемого массива строк: TRUE - создается динамический массив строк текста типа TEXT_LINE_ARR, FALSE - создается динамический массив строк текста типа CHAR_STR_ARR.
Возвращаемое значение:
TRUE    - в случае удачного завершения.

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

SetBitFlagValue - Установить значение одного из флагов признака bitFlag

Синтаксис Automation:

BOOL SetBitFlagValue (long bitFlag,
BOOL state);
Входные параметры:
bitFlag    - битовый флаг, характеризующий определенный признак размерной надписи,
state    - состояние указанного битового флага: TRUE - включен, FALSE - выключен.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
См. также свойство bitFlag

SetTextArr - Установить динамический массив параметров строк

Синтаксис Automation:

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

sign - Тип условного значка перед номиналом размера

Тип данных:long. Значения свойства:

0	- нет значка,
1	- диаметр,
2	- квадрат,
3	- радиус,
>3	- номер значка из шрифта "Symbol type A",
4	- М - метрическая резьба,
210	- символ сферы.
Синтаксис Automation:

sign = iDimText.sign    Получить свойство (* )
iDimText.sign = sign    Установить свойство (* )
sign = iDimText.GetSign()    Получить свойство (**)
iDimText.SetSign( sign )    Установить свойство (**)

stringFlag - Тип используемого массива строк

Тип данных:BOOL. Значения свойства:

FALSE	- тип CHAR_STR_ARR - динамический массив строк символов,
TRUE	- тип TEXT_LINE_ARR - динамический массив строк текста.
Синтаксис Automation:

stringFlag = iDimText.stringFlag    Получить свойство (* )
iDimText.stringFlag = stringFlag    Установить свойство (* )
stringFlag = iDimText.GetStringFlag()    Получить свойство (**)
iDimText.SetStringFlag( stringFlag )    Установить свойство (**)

Примечание: Для функции ksDocument2D::ksGetObjParam нужно определить свойство stringFlag. Смотрите также: – ksDimTextParam::SetTextArr – ksDimTextParam::GetTextArr

style - Стиль текста размера

Тип данных:long. Значения свойства:

номер системного стиля,
номер пользовательского стиля.
Синтаксис Automation:

style = iDimText.style    Получить свойство (* )
iDimText.style = style    Установить свойство (* )
style = iDimText.GetStyle()    Получить свойство (**)
iDimText.SetStyle( style )    Установить свойство (**)
Системные стили текста...