---
title: "Параметры сохранения растра (Интерфейсы ksRasterFormatParam, IRasterFormatParam)"
type: interface
api: [api7]
domain: [3d]
tags: [interface, api7, 3d, ksrasterformatparam]
sources:
  - ksrasterformatparam.html
---

*API интерфейсов. Версия 5 > Документ-модель (Интерфейсы - ksDocument3D, IDocument3D ) *


## Параметры сохранения растра (Интерфейсы ksRasterFormatParam, IRasterFormatParam)

Интерфейс параметров для записи документа в растровом формате.
| ksRasterFormatParam | - интерфейс Automation |
| --- | --- |
| IRasterFormatParam | - интерфейс COM |
Аналог данных параметров при использовании API экспортных функций - RasterFormatParam.
Примечание:
Данный интерфейс может быть получен с использованием методов интерфейсов ksSpcDocument::RasterFormatParam, ksDocument3D::RasterFormatParam, ksDocumentTxt::RasterFormatParam, ksDocument2D::RasterFormatParam.


## colorBPP - Цветность растра

Тип данных: short
Значения свойства...
Синтаксис Automation:
```
colorBPP = iRasterFormatParam.colorBPP    Получить свойство(* )
iRasterFormatParam.colorBPP = colorBPP    Установить свойство (* )
colorBPP = iRasterFormatParam.GetColorBPP()    Получить свойство (**)
iRasterFormatParam.SetColorBPP(colorBPP)    Установить свойство (**)
```


## сolorType - Цвет вывода объектов

Тип данных: short
Значения свойства...
Синтаксис Automation:
```
сolorType = iRasterFormatParam.сolorType    Получить свойство(* )
iRasterFormatParam.сolorType = сolorType    Установить свойство (* )
сolorType = iRasterFormatParam.GetСolorType()    Получить свойство (**)
iRasterFormatParam.SetСolorType(сolorType)    Установить свойство (**)
```


## extResolution - Разрешение растра

Тип данных: long
Синтаксис Automation:
```
extResolution = iRasterFormatParam.extResolution    Получить свойство(* )
iRasterFormatParam.extResolution = extResolution    Установить свойство (* )
extResolution = iRasterFormatParam.GetExtResolution()    Получить свойство (**)
iRasterFormatParam.SetExtResolution(extResolution)    Установить свойство (**)
```
Примечание:
Значение 0 соответствует текущему экранному разрешению.


## extScale - Масштаб

Тип данных: double
Синтаксис Automation:
```
extScale = iRasterFormatParam.extScale    Получить свойство(* )
iRasterFormatParam.extScale = extScale    Установить свойство (* )
extScale = iRasterFormatParam.GetExtScale()    Получить свойство (**)
iRasterFormatParam.SetExtScale(extScale)    Установить свойство (**)
```


## format - Формат растра

Тип данных: short
Значения свойства...
Синтаксис Automation:
```
format = iRasterFormatParam.format    Получить свойство(* )
iRasterFormatParam.format = format    Установить свойство (* )
format = iRasterFormatParam.GetFormat()    Получить свойство (**)
iRasterFormatParam.SetFormat(format)    Установить свойство (**)
```


## greyScale - Признак сохранения в оттенках серого

Тип данных: BOOL
Значения свойства:
| TRUE | - использовать оттенки серого, |
| --- | --- |
| FALSE | - сохранять цветной растр. |
Синтаксис Automation:
```
greyScale = iRasterFormatParam.greyScale    Получить свойство(* )
iRasterFormatParam.greyScale = greyScale    Установить свойство (* )
greyScale = iRasterFormatParam.GetGreyScale()    Получить свойство (**)
iRasterFormatParam.SetGreyScale(greyScale)    Установить свойство (**)
```


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

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


## multiPageOutput - Признак сохранения всех листов в одном файле

Тип данных: BOOL
Значения свойства:
| TRUE | - сохранять все листы в одном файле, |
| --- | --- |
| FALSE | - сохранять листы в отдельных файлах. |
Синтаксис Automation:
```
multiPageOutput = iRasterFormatParam.multiPageOutput    Получить свойство(* )
iRasterFormatParam.multiPageOutput = multiPageOutput    Установить свойство (* )
multiPageOutput = iRasterFormatParam.GetMultiPageOutput()    Получить свойство (**)
iRasterFormatParam.SetMultiPageOutput(multiPageOutput)    Установить свойство (**)
```
Примечание:
Свойство используется только для формата TIFF.


## onlyThinLine - Признак вывода всех линий тонкими

Тип данных: BOOL
Значения свойства:
| TRUE | - выводить все только тонкими линиями, |
| --- | --- |
| FALSE | - использовать установленные для объектов толщины линий. |
Синтаксис Automation:
```
onlyThinLine = iRasterFormatParam.onlyThinLine    Получить свойство(* )
iRasterFormatParam.onlyThinLine = onlyThinLine    Установить свойство (* )
onlyThinLine = iRasterFormatParam.GetOnlyThinLine()    Получить свойство (**)
iRasterFormatParam.SetOnlyThinLine(onlyThinLine)    Установить свойство (**)
```


## pages - Список диапазонов выводимых страниц

Тип данных: строка
Значения свойства:
Формат списка - "beg1-end1, beg2-end2, beg3-end3, ...",
где begN - начало N-го интервала, endN - конец N-го интервала.
Например, "1-18, 24-25".
Синтаксис Automation:
```
pages = iRasterFormatParam.pages    Получить свойство(* )
iRasterFormatParam.pages = pages    Установить свойство (* )
pages = iRasterFormatParam.GetPages()    Получить свойство (**)
iRasterFormatParam.SetPages(pages)    Установить свойство (**)
```
Примечание:
1. Свойство используется для многолистовых документов (текстовых документов и спецификаций).
2. Если строка пуста, свойство не используется.


## rangeIndex - Признак выбора стороны страниц

Тип данных: short
Значения свойства:
| 0 | - все страницы, |
| --- | --- |
| 1 | - нечетные страницы, |
| 2 | - четные страницы. |
Синтаксис Automation:
```
rangeIndex = iRasterFormatParam.rangeIndex    Получить свойство(* )
iRasterFormatParam.rangeIndex = rangeIndex    Установить свойство (* )
rangeIndex = iRasterFormatParam.GetRangeIndex()    Получить свойство (**)
iRasterFormatParam.SetRangeIndex(rangeIndex)    Установить свойство (**)
```
Примечание:
Свойство используется для многолистовых документов (текстовых документов и спецификаций).


## resultArrayBytes - Результат сохранения в растр в виде массива байт

Тип данных: VARIANT
Синтаксис:
```
resultArrayBytes = Object.resultArrayBytes    Получить свойство(* )
Object.resultArrayBytes = resultArrayBytes    Установить свойство (* )
resultArrayBytes = Object.GetResultArrayBytes()    Получить свойство (**)
Object.SetResultArrayBytes( resultArrayBytes )    Установить свойство (**)
```
Примечание:
•Для одностраничного растра возвращается массив байт VT_ARRAY | VT_UI1.
•Для многостраничного растра возвращается массив VT_ARRAY | VT_VARIANT, каждая страница добавляется отдельным элементом в массив ввиде массива байт VT_ARRAY | VT_UI1.


## returnResultAsArrayBytes - Вернуть результат массивом байт

Тип данных: BOOL
Синтаксис:
```
returnResultAsArrayBytes = Object.returnResultAsArrayBytes    Получить свойство(* )
Object.returnResultAsArrayBytes = returnResultAsArrayBytes    Установить свойство (* )
returnResultAsArrayBytes = Object.GetReturnResultAsArrayBytes()    Получить свойство (**)
Object.SetReturnResultAsArrayBytes( returnResultAsArrayBytes )    Установить свойство (**)
```


## saveWorkArea - Cохранить отображение рабочей области

Тип данных: BOOL
Синтаксис:
```
saveWorkArea = Object.saveWorkArea    Получить свойство(* )
Object.saveWorkArea = saveWorkArea    Установить свойство (* )
saveWorkArea = Object.GetSaveWorkArea()    Получить свойство (**)
Object.SetSaveWorkArea( saveWorkArea )    Установить свойство (**)
```
