---
title: "Интерфейсы параметров элементов текста"
type: interface
api: [api7]
tags: [interface, api7, ck1918891]
sources:
  - ck1918891.html
  - kstextparam.html
  - kstextlineparam.html
  - ksparagraphparam.html
  - kstextitemfont.html
  - kstextitemparam.html
---

*API интерфейсов. Версия 5 > Текстовый документ (Интерфейс ksDocumentTxt)  > ksDocumentTxt - методы *




## Интерфейс ksTextParam

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


## GetParagraphParam - Получить указатель на интерфейс параметров параграфа ksParagraphParam

Синтаксис Automation:
```
LPDISPATCH GetParagraphParam();
Возвращаемое значение:
- указатель на интерфейс параметров параграфа ksParagraphParam.
```


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

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


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

Синтаксис Automation:
```
BOOL Init();
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечание:
Метод обнуляет все параметры текста.


## SetParagraphParam - Установить параметры параграфа ksParagraphParam

Синтаксис Automation:
```
BOOL SetParagraphParam(LPDISPATCH par);
Входной параметр:
par    - указатель на интерфейс параметров параграфа ksParagraphParam.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```


## SetTextLineArr - Заменить динамический массив ksDynamicArray строк текста типа TEXT_LINE_ARR

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


## Интерфейс ksTextLineParam

Интерфейс параметров строки текста.
Аналог данных параметров при использовании API экспортных функций - TextLineParam.
Примечание:
Указатель на интерфейс можно получить при помощи метода ompasObject::GetParamStruct.
Смотрите также KompasObject


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

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


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

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


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

Синтаксис Automation:
```
BOOL SetTextItemArr (LPDISPATCH pTextItem);
Входной параметр:
pTextItem    - указатель на интерфейс динамического массива ksDynamicArray типа TEXT_ITEM_ARR.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
Смотрите также ksTextItemParam
```


## style - Стиль строки текста

Тип данных: long
Значения свойства:
| номер системного стиля, | |
| --- | --- |
| номер пользовательского стиля. | |
Синтаксис Automation:
```
style = iTextLineParam.style    Получить свойство (* )
iTextLineParam.style = style    Установить свойство (* )
style = iTextLineParam.GetStyle()    Получить свойство (**)
iTextLineParam.SetStyle( style )    Установить свойство (**)
Системные стили текстов...
```


## Интерфейс ksParagraphParam

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


## ang - Угол наклона текста

Тип данных: double
Синтаксис Automation:
```
ang = iParagraphParam.ang    Получить свойство (* )
iParagraphParam.ang = ang    Установить свойство (* )
ang = iParagraphParam.GetAng()    Получить свойство (**)
iParagraphParam.SetAng( ang )    Установить свойство (**)
```


## height - Высота блока форматирования

Тип данных: double
Синтаксис Automation:
```
height = iParagraphParam.height    Получить свойство (* )
iParagraphParam.height = height    Установить свойство (* )
height = iParagraphParam.GetHeight()    Получить свойство (**)
iParagraphParam.SetHeight( height )    Установить свойство (**)
```


## hFormat - Признак форматирования по горизонтали

Тип данных: long
Значения свойства:
| 0 | - нет форматирования, |
| --- | --- |
| 1 | - сужение текста, |
| 2 | - перенос на другую строку. |
Синтаксис Automation:
```
hFormat = iParagraphParam.hFormat    Получить свойство (* )
iParagraphParam.hFormat = hFormat    Установить свойство (* )
hFormat = iParagraphParam.GetHFormat()    Получить свойство (**)
iParagraphParam.SetHFormat(hFormat )    Установить свойство (**)
```


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

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


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

Тип данных: long
Синтаксис Automation:
```
style = iParagraphParam.style    Получить свойство (* )
iParagraphParam.style = style    Установить свойство (* )
style = iParagraphParam.GetStyle()    Получить свойство (**)
iParagraphParam.SetStyle( style )    Установить свойство (**)
Системные стили текстов...
```


## vFormat - Признак форматирования по вертикали

Тип данных: long
Значения свойства:
| 0 | - нет форматирования, |
| --- | --- |
| -1 | - изменение шага строк. |
Синтаксис Automation:
```
vFormat = iParagraphParam.vFormat    Получить свойство (* )
iParagraphParam.vFormat = vFormat    Установить свойство (* )
vFormat = iParagraphParam.GetVFormat()    Получить свойство (**)
iParagraphParam.SetVFormat( vFormat )    Установить свойство (**)
```


## width - Ширина блока форматирования

Тип данных: double
Синтаксис Automation:
```
width = iParagraphParam.width    Получить свойство (* )
iParagraphParam.width = width    Установить свойство (* )
width = iParagraphParam.GetWidth()    Получить свойство (**)
iParagraphParam.SetWidth(width )    Установить свойство (**)
```


## x, y - Координаты точки привязки текста

Тип данных: double
Синтаксис Automation:
```
x = iParagraphParam.x    Получить свойство (* )
iParagraphParam.x = x    Установить свойство (* )
x = iParagraphParam.GetX()    Получить свойство (**)
iParagraphParam.SetX( x )    Установить свойство (**)
```


## Интерфейс ksTextItemFont

Интерфейс параметров шрифта компоненты строки текста.
Аналог данных параметров при использовании API экспортных функций - TextItemFont.
Примечание:
Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct.
Смотрите также
KompasObject


## bitvector - Битовый вектор, определяющий начертание символов (наклон, толщину, подчеркивание, тип составной части - дробь, отклонение и т.д.)

Тип данных: long
Синтаксис Automation:
```
bitvector = iTextItemFont.bitvector    Получить свойство (* )
iTextItemFont.bitvector = bitvector    Установить свойство (* )
bitvector = iTextItemFont.GetBitVector()    Получить свойство (**)
iTextItemFont.SetBitVector( bitvector )    Установить свойство (**)
Признаки начертания текста...
```


## color - Цвет символов

Тип данных: long
Синтаксис Automation:
```
color = iTextItemFont.color    Получить свойство (* )
iTextItemFont.color = color    Установить свойство (* )
color = iTextItemFont.GetColor()    Получить свойство (**)
iTextItemFont.SetColor( color )    Установить свойство (**)
```


## fontName - Имя шрифта

Тип данных: строка
Синтаксис Automation:
```
fontName = iTextItemFont.fontName    Получить свойство (* )
iTextItemFont.fontName = fontName    Установить свойство (* )
fontName = iTextItemFont.GetFontName()    Получить свойство (**)
iTextItemFont.SetFontName( fontName )    Установить свойство (**)
```


## GetBitVectorValue - Получить значение битового вектора, определяющего начертание символов

Синтаксис Automation:
```
BOOL GetBitVectorValue (long bitVector);
Выходной параметр:
bitVector    - значение битового флага.
Признаки начертания текста...
Возвращаемое значение:
TRUE    - если флаги "взведены",
FALSE    - если флаги "сброшены".
```
Примечание:
В отличие от GetBitVector этот метод позволяет получить значение конкретного флага.


## height - Высота шрифта (в миллиметрах)

Тип данных: double
Синтаксис Automation:
```
height = iTextItemFont.height    Получить свойство (* )
iTextItemFont.height = height    Установить свойство (* )
height = iTextItemFont.GetHeight()    Получить свойство (**)
iTextItemFont.SetHeight( height )    Установить свойство (**)
```


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

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


## ksu - Коэффициент сужения символов

Тип данных: double
Синтаксис Automation:
```
ksu = iTextItemFont.ksu    Получить свойство (* )
iTextItemFont.ksu = ksu    Установить свойство (* )
ksu = iTextItemFont.GetKsu()    Получить свойство (**)
iTextItemFont.SetKsu( ksu )    Установить свойство (**)
```


## SetBitVectorValue - "Взвести" или "сбросить" значение битового вектора

Синтаксис Automation:
```
BOOL SetBitVectorValue (long bitVector, BOOL state);
Входные параметры:
bitVector    - значение битового вектора,
state    - состояние вектора: TRUE - включить, FALSE - выключить.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечание:
В отличие от SetBitVector этот метод позволяет установить значение конкретного флага.


## Интерфейс ksTextItemParam

Интерфейс параметров компоненты строки текста.
Аналог данных параметров при использовании API экспортных функций - TextItemParam.
Примечание:
Указатель на интерфейс можно получить при помощи метода ompasObject::GetParamStruct.
Смотрите также KompasObject


## GetItemFont - Получить указатель на интерфейс свойств шрифта компоненты строки текста

Синтаксис Automation:
```
LPDISPATCH GetItemFont();
Возвращаемое значение:
- указатель на интерфейс ksTextItemFont.
```


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

Синтаксис Automation:
```
BOOL Init();
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечание:
Метод обнуляет все параметры компоненты строки текста.


## iSNumb - Номер спецсимвола, символа из произвольного шрифта или тип отрисовки дроби, или выражения типа суммы, или 0

Тип данных: long
Синтаксис Automation:
```
iSNumb = iTextItemParam.iSNumb    Получить свойство (* )
iTextItemParam.iSNumb = iSNumb    Установить свойство (* )
iSNumb = iTextItemParam.GetISNumb()    Получить свойство (**)
iTextItemParam.SetISNumb(iSNumb)    Установить свойство (**)
Примечание.
Таблица спецсимволов размещена в файле SDK\NumbSymb.frw.
```


## s - Массив символов для компоненты текста

Тип данных: BSTR
Синтаксис Automation:
```
s = iTextItemParam.s    Получить свойство (* )
iTextItemParam.s = s    Установить свойство (* )
s = iTextItemParam.GetS()    Получить свойство (**)
iTextItemParam.SetS(s)    Установить свойство (**)
```


## SetItemFont - Установить указатель на интерфейс свойств шрифта компоненты строки текста

Синтаксис Automation:
```
BOOL SetItemFont(LPDISPATCH font);
Входной параметр:
font    - указатель на интерфейс свойств шрифта компоненты строки текста ksTextItemFont.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```


## type - Тип символа

Тип данных: long
Синтаксис Automation:
```
type = iTextItemParam.type    Получить свойство (* )
iTextItemParam.type = type    Установить свойство (* )
type = iTextItemParam.GetType()    Получить свойство (**)
iTextItemParam.SetType(type)    Установить свойство (**)
```
