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

title, type, api, domain, tags, sources

title	type	api	domain	tags	sources
Знак изменения (Интерфейс ksChangeLeaderParam)	interface	api7	2d	interface api7 2d kschangeleaderparam	kschangeleaderparam.html

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

Знак изменения (Интерфейс ksChangeLeaderParam)

Интерфейс параметров линии-выноски для обозначения изменения. Аналог данных параметров при использовании API экспортных функций - ChangeLeaderParam. Описание. Интерфейс позволяет задать параметры для создания обозначения изменения (см. функцию ksDocument2D::ksChangeLeader, а также используется для получения и изменения параметров обозначения изменения (см. функции ksDocument2D::ksGetObjParam и ksDocument2D::ksSetObjParam). Примечание: Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct. Смотрите также: KompasObject

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

Синтаксис Automation:

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

Примечание: В общем случае одно ответвление - это ломаная линия. Первый узел - базовая точка (ее в массив помещать не нужно, т.к. она общая для всех ответвлений), остальные узлы - изломы (могут отсутствовать), последний узел - конец ответвления (указывает на объект). Смотрите также: ksMathPointParam

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

Синтаксис Automation:

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

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

Синтаксис Automation:

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

Примечания:

1. Метод обнуляет все параметры.
2. Создается динамический массив pTextline типа TEXT_LINE_ARR.
3. Создается динамический массив pPolytline типа POLYLINE_ARR.

leaderLength - Длина ответвлений

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

leaderLength = ksChangeLeaderParam.leaderLength    Получить свойство (* )
ksChangeLeaderParam.leaderLength = leaderLength    Установить свойство (* )
leaderLength = ksChangeLeaderParam.GetleaderLength()    Получить свойство (**)
ksChangeLeaderParam.SetleaderLength( dirX )    Установить свойство (**)

Примечание: Если leaderLength >= 0, длина всех ответвлений одинакова и равна leaderLength. Если leaderLength < 0 - ответвление на всю длину. Длина для каждого ответвления задается координатами конца ответвления.

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

Синтаксис Automation:

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

Примечание: В общем случае одно ответвление - это ломаная линия. Первый узел - базовая точка (ее в массив помещать не нужно, т.к. она общая для всех ответвлений), остальные узлы - изломы (могут отсутствовать), последний узел - конец ответвления (указывает на объект). Смотрите также: ksMathPointParam

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

Синтаксис Automation:

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

signHeight - Высота или диаметр значка

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

signHeight = ksChangeLeaderParam.signHeight    Получить свойство (* )
ksChangeLeaderParam.signHeight = signHeight    Установить свойство (* )
signHeight = ksChangeLeaderParam.GetsignHeight()    Получить свойство (**)
ksChangeLeaderParam.SetsignHeight(signHeight)    Установить свойство (**)

signType - Тип значка

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

0	- квадрат,
1	- окружность,
2	- квадратные скобки,
3	- круглые скобки,
4	- угловые скобки.
Синтаксис Automation:

signType = ksChangeLeaderParam.signType    Получить свойство (* )
ksChangeLeaderParam.signType = signType    Установить свойство (* )
signType = ksChangeLeaderParam.GetSignType()    Получить свойство (**)
ksChangeLeaderParam.SetSignType( signType )    Установить свойство (**)

style - Стиль текста

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

номер системного стиля,
номер пользовательского стиля.
INDICATIN_TEXT_LINE_ARR	- в этом случае текст задается массивом строк, и стиль текста может быть указан индивидуально для каждой строки.
Системные стили текстов...
Синтаксис Automation:

style = iChangeLeaderParam.style    Получить свойство (* )
iChangeLeaderParam.style = style    Установить свойство (* )
style = iChangeLeaderParam.GetStyle()    Получить свойство (**)
iChangeLeaderParam.SetStyle( style )    Установить свойство (**)

Примечание: Если style = INDICATIN_TEXT_LINE_ARR, то динамический массив pText - типа TEXT_LINE_ARR. В остальных случаях - типа CHAR_STR_ARR.

x - Координата X базовой точки обозначения изменения

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

x = ksChangeLeaderParam.x    Получить свойство (* )
ksChangeLeaderParam.x = x    Установить свойство (* )
x = ksChangeLeaderParam.GetX()    Получить свойство (**)
ksChangeLeaderParam.SetX(x)    Установить свойство (**)

y - Координата Y базовой точки обозначения изменения

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

y = ksChangeLeaderParam.y    Получить свойство (* )
ksChangeLeaderParam.y = y    Установить свойство (* )
y = ksChangeLeaderParam.GetY()    Получить свойство (**)
ksChangeLeaderParam.SetY(y)    Установить свойство (**)