LayOut C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Variables
documentexportoptions.h File Reference

Go to the source code of this file.

Variables

const char *const LOExportOption_FileLocation = "lo_export_file_location"
 Dictionary key to use when specifying the file location for export. More...
 
const char *const LOExportOption_StartPage = "start_page"
 Dictionary key to use when specifying the start page option for LODocumentExportToPDF or LODocumentExportToImageSet. More...
 
const char *const LOExportOption_EndPage = "end_page"
 Dictionary key to use when specifying the end page option for LODocumentExportToPDF or LODocumentExportToImageSet. More...
 
const char *const LOExportOption_PageRange = "page_range"
 Dictionary key to use when specifying the page range option for LODocumentExportToPDF or LODocumentExportToImageSet. The value stored with this key takes precedent over "start_page" and "end_page". More...
 
const char *const LOExportOption_PageRangeType = "page_range_type"
 Dictionary key to use when specifying the page range type option for LODocumentExportToPDF or LODocumentExportToImageSet. If this value is set to LOExportPageRangeType_All, then "start_page", "end_page", and "page_range" are ignored. If not set, or set to LOExportPageRangeType_Range, then those values will be used as outlined. More...
 
const int LOExportPageRangeType_All = 0
 Dictionary values to use for the LOExportOption_PageRangeType key. More...
 
const int LOExportPageRangeType_Range = 1
 
const char *const LOExportOption_OutputResolution = "output_resolution"
 Dictionary key to use when specifying the output resolution option for LODocumentExportToPDF. More...
 
const char *const LOExportOption_CompressImages = "compress_images"
 Dictionary key to use when specifying the compress images option for LODocumentExportToPDF. More...
 
const char *const LOExportOption_ImageCompressionQuality = "compress_quality"
 Dictionary key to use when specifying the image compression quality option for LODocumentExportToPDF. More...
 
const char *const LOExportOption_DPI = "dpi"
 Dictionary key to use when specifying the image DPI option for LODocumentExportToImageSet. More...
 

Variable Documentation

const char* const LOExportOption_CompressImages = "compress_images"

Dictionary key to use when specifying the compress images option for LODocumentExportToPDF.

const char* const LOExportOption_DPI = "dpi"

Dictionary key to use when specifying the image DPI option for LODocumentExportToImageSet.

const char* const LOExportOption_EndPage = "end_page"

Dictionary key to use when specifying the end page option for LODocumentExportToPDF or LODocumentExportToImageSet.

const char* const LOExportOption_FileLocation = "lo_export_file_location"

Dictionary key to use when specifying the file location for export.

const char* const LOExportOption_ImageCompressionQuality = "compress_quality"

Dictionary key to use when specifying the image compression quality option for LODocumentExportToPDF.

const char* const LOExportOption_OutputResolution = "output_resolution"

Dictionary key to use when specifying the output resolution option for LODocumentExportToPDF.

Deprecated:
This key is deprecated as of 2023.1. Set the output resolution of images and viewports through the LOPageInfoSetImageOutputResolution and LOPageInfoSetOutputResolution respectively.
const char* const LOExportOption_PageRange = "page_range"

Dictionary key to use when specifying the page range option for LODocumentExportToPDF or LODocumentExportToImageSet. The value stored with this key takes precedent over "start_page" and "end_page".

Since
LayOut 2024.0, API 9.0
const char* const LOExportOption_PageRangeType = "page_range_type"

Dictionary key to use when specifying the page range type option for LODocumentExportToPDF or LODocumentExportToImageSet. If this value is set to LOExportPageRangeType_All, then "start_page", "end_page", and "page_range" are ignored. If not set, or set to LOExportPageRangeType_Range, then those values will be used as outlined.

Since
LayOut 2025.0, API 10.0
const char* const LOExportOption_StartPage = "start_page"

Dictionary key to use when specifying the start page option for LODocumentExportToPDF or LODocumentExportToImageSet.

const int LOExportPageRangeType_All = 0

Dictionary values to use for the LOExportOption_PageRangeType key.

Since
LayOut 2025.0, API 10.0
const int LOExportPageRangeType_Range = 1