---
title: "Линия-выноска для обозначения параметров клеймения (Интерфейс ksBrandLeaderParam)"
type: interface
api: [api7]
tags: [interface, api7, ksbrandleaderparam]
sources:
  - ksbrandleaderparam.html
---

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


## Линия-выноска для обозначения параметров клеймения (Интерфейс ksBrandLeaderParam)

Интерфейс параметров линии-выноски для обозначения клеймения.
Аналог данных параметров при использовании API экспортных функций - BrandLeaderParam.
Примечания:
1. Если cText0 = 0 или cText1 = 0 или cText2 = 0, то соответствующий текст на линии-выноске отсутствует.
2. Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct.
Смотрите также: KompasObject


## arrowType - Тип знака на "ножке" линии-выноски обозначения клеймения

Интерфейс..
Тип данных: short
Значения свойства:
| 0 | - знак отсутствует, |
| --- | --- |
| 1 | - точка, |
| 2 | - стрелка. |
Синтаксис Automation:
```
arrowType = iBrandLeaderParam.arrowType    Получить свойство (* )
iBrandLeaderParam.arrowType = arrowType    Установить свойство (* )
arrowType = iBrandLeaderParam.GetArrowType()    Получить свойство (**)
iBrandLeaderParam.SetArrowType( arrowType )    Установить свойство (**)
```


## cText0 - Количество строк текста в знаке клеймения (не более одной строки)

Интерфейс..
Тип данных: short
Синтаксис Automation:
```
cText0 = iBrandLeaderParam.cText0    Получить свойство (* )
iBrandLeaderParam.cText0 = cText0    Установить свойство (* )
cText0 = iBrandLeaderParam.GetCText0()    Получить свойство (**)
iBrandLeaderParam.SetCText0( cText0 )    Установить свойство (**)
```


## cText1 - Количество строк текста над "ножкой" (не более одной строки)

Интерфейс..
Тип данных: short
Синтаксис Automation:
```
cText1 = iBrandLeaderParam.cText1    Получить свойство (* )
iBrandLeaderParam.cText1 = cText1    Установить свойство (* )
cText1 = iBrandLeaderParam.GetCText1()    Получить свойство (**)
iBrandLeaderParam.SetCText1( cText1 )    Установить свойство (**)
```


## cText2 - Количество строк текста под "ножкой" (не более одной строки)

Интерфейс..
Тип данных: short
Синтаксис Automation:
```
cText2 = iBrandLeaderParam.cText2    Получить свойство (* )
iBrandLeaderParam.cText2 = cText2    Установить свойство (* )
cText2 = iBrandLeaderParam.GetCText2()    Получить свойство (**)
iBrandLeaderParam.SetCText2( cText2 )    Установить свойство (**)
```


## dirX - Направление полки относительно оси OX

Интерфейс..
Тип данных: long
Значения свойства:
| 1 | - вправо (по оси OX), |
| --- | --- |
| -1 | - влево (против оси OX). |
Синтаксис Automation:
```
dirX = iBrandLeaderParam.dirX    Получить свойство (* )
iBrandLeaderParam.dirX = dirX    Установить свойство (* )
dirX = iBrandLeaderParam.GetDirX()    Получить свойство (**)
iBrandLeaderParam.SetDirX( dirX )    Установить свойство (**)
```


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

Интерфейс..
Получить указатель на интерфейс динамического массива ответвлений линии-выноски обозначения клеймения ksDynamicArray типа POLYLINE_ARR.
Синтаксис Automation:
```
LPDISPATCH GetpPolyline();
Возвращаемое значение:
- указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_AR.
```
Примечание:
В общем случае одно ответвление - это ломаная линия. Первый узел - базовая точка (ее в массив помещать не нужно, т.к. она общая для всех ответвлений), остальные узлы - изломы (могут отсутствовать), последний узел - конец ответвления (указывает на объект).
Смотрите также: ksMathPointParam


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

Интерфейс..
Синтаксис Automation:
```
LPDISPATCH GetpTextline();
Возвращаемое значение:
- указатель на интерфейс динамического массива ksDynamicArray.
```
Примечания:
1. Если свойство ksBrandLeaderParam::style1 = INDICATIN_TEXT_LINE_ARR, то динамический массив - типа TEXT_LINE_ARR (динамический массив строк текста), в остальных случаях - типа CHAR_STR_ARR (динамический массив строк символов текста клеймения).
2. Различают три разных текста для обозначения клеймения, их строки лежат в следующей последовательности:
•текст над полкой. Если свойство cText0 = 0, то этот текст отсутствует;
•текста над "ножкой". Если свойство cText1 = 0, то этот текст отсутствует;
•текст под "ножкой". Если свойство cText2 = 0, то этот текст отсутствует.
Смотрите также:
ksTextLineParam
ksChar255


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

Интерфейс..
Синтаксис Automation:
```
BOOL Init();
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечания:
1. Метод обнуляет все параметры.
2. Создается динамический массив pText типа CHAR_STR_ARR.
3. Создается динамический массив pPolyline типа POLYLINE_ARR.


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

Интерфейс..
Синтаксис Automation:
```
BOOL SetpPolyline (LPDISPATCH pPolyline);
Входной параметр:
pPolyline    - указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_ARR.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечание:
В общем случае одно ответвление - это ломаная линия. Первый узел - базовая точка (ее в массив помещать не нужно, т.к. она общая для всех ответвлений), остальные узлы - изломы (могут отсутствовать), последний узел - конец ответвления (указывает на объект).
Смотрите также: ksMathPointParam


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

Интерфейс..
Синтаксис Automation:
```
BOOL SetpTextline (LPDISPATCH pTextline);
Входной параметр:
pTextline    - указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_AR.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечания:
1. Если свойство ksBrandLeaderParam::style1 = INDICATIN_TEXT_LINE_ARR, то динамический массив ksDynamicArray - типа TEXT_LINE_ARR (динамический массив строк текста), в остальных случаях - типа CHAR_STR_ARR (динамический массив строк символов текста клеймения).
2. Различают три разных текста для обозначения клеймения, их строки лежат в следующей последовательности:
•текст над полкой. Если свойство cText0 = 0, то этот текст отсутствует;
•текста над "ножкой". Если свойство cText1 = 0, то этот текст отсутствует;
•текст под "ножкой". Если свойство свойство cText2 = 0, то этот текст отсутствует.
Смотрите также:
ksTextLineParam
ksChar255


## style1 - Стиль текста в знаке клеймения

Интерфейс..
Тип данных: long
Значения свойства:
| номер системного стиля, | |
| --- | --- |
| номер пользовательского стиля, | |
| INDICATIN_TEXT_LINE_ARR | - в этом случае текст задается массивом строк и стиль текста может быть указан индивидуально для каждой строки. |
Системные стили текстов...
Синтаксис Automation:
```
style1 = iBrandLeaderParam.style1    Получить свойство (* )
iBrandLeaderParam.style1 = style1    Установить свойство (* )
style1 = iBrandLeaderParam.GetStyle1()    Получить свойство (**)
iBrandLeaderParam.SetStyle1( style1 )    Установить свойство (**)
```
Примечание:
Если style1 = INDICATIN_TEXT_LINE_ARR, то динамический массив текстов - типа TEXT_LINE_ARR. В остальных случаях - типа CHAR_STR_ARR.


## style2 - Стиль текстов у "ножки" знака клеймения

Интерфейс..
Тип данных: long
Значения свойства:
| номер системного стиля, | |
| --- | --- |
| номер пользовательского стиля. | |
Системные стили текстов...
Синтаксис Automation:
```
style2 = iBrandLeaderParam.style2    Получить свойство (* )
iBrandLeaderParam.style1 = style2    Установить свойство (* )
style2 = iBrandLeaderParam.GetStyle2()    Получить свойство (**)
iBrandLeaderParam.SetStyle2( style2 )    Установить свойство (**)
```
Примечание:
Используется, если style1 не равен INDICATIN_TEXT_LINE_ARR.


## x, y - Координаты базовой точки обозначения клеймения

Интерфейс..
Тип данных: double
Синтаксис Automation:
```
x = iBrandLeaderParam.x    Получить свойство (* )
iBrandLeaderParam.x = x    Установить свойство (* )
x = iBrandLeaderParam.GetX()    Получить свойство (**)
iBrandLeaderParam.SetX( x )    Установить свойство (**)
```
Примечание:
Базовая точка обозначения клеймения - точка выхода из знака "ножки".
