com.stimulsoft.report.options

Class ExportOptions.Rtf

java.lang.Object

com.stimulsoft.report.options.ExportOptions.Rtf

Enclosing class:

ExportOptions

public static final class ExportOptions.Rtf
extends java.lang.Object

Class for adjustment of the Rtf export of a report.

Constructor Summary

Constructors

Constructor and Description
ExportOptions.Rtf()

Method Summary

Methods

Modifier and Type	Method and Description
static StiArabicDigitsType	getArabicDigitsType() Gets or sets a value indicating a current arabic type of digits.
static int	getBottomMarginCorrection() A value of bottom margin correction
static boolean	getConvertDigitsToArabic() Gets or sets a value, which indicates whether it is necessary to convert all digits to arabic digits.
static boolean	getDivideBigCells() When Rtf exporting big cells will be divided into small cells.
static boolean	getDivideSegmentPages() When Rtf exporting segmented pages will be forcibly broken in order of chosen page format.
static boolean	getForceEmptyCellsOptimization() Gets or sets a value indicating a forcing of empty cells optimization.
static boolean	getForceLineHeight() Gets or sets a value indicating a forcing of line height.
static boolean	getLineHeightExactly() Gets or sets a value indicating a line height mode - "exactly" or "at least".
static double	getLineSpacing() Gets or sets a value of line spacing
static boolean	getRemoveEmptySpaceAtBottom() Gets or sets a value indicating whether it is necessary to remove empty space at the bottom of page
static int	getRightMarginCorrection() Gets or sets a value of right margin correction
static int	getSpaceBetweenCharacters() Gets or sets a value of expansion or compression of the space between characters in twips; a negative value compresses.
static boolean	getUseCanBreakProperty() Gets or sets a value indicating whether it is necessary to use CanBreak property of components.
static boolean	getUsePageRefField() Gets or sets a value indicating whether it is necessary to use PAGEREF field of MS-Word.
static boolean	getUseTemplatePageSize() When Rtf exporting segmented pages will be forcibly use the page size from template.
static boolean	isUseNewPageCommandInsteadOfNewSection() A value indicating whether it is necessary to use NewPage command instead of NewSection
static void	setArabicDigitsType(StiArabicDigitsType value)
static void	setBottomMarginCorrection(int bottomMarginCorrection)
static void	setConvertDigitsToArabic(boolean value)
static void	setDivideBigCells(boolean value)
static void	setDivideSegmentPages(boolean value)
static void	setForceEmptyCellsOptimization(boolean forceEmptyCellsOptimization)
static void	setForceLineHeight(boolean value)
static void	setLineHeightExactly(boolean value)
static void	setLineSpacing(double value)
static void	setRemoveEmptySpaceAtBottom(boolean value)
static void	setRightMarginCorrection(int value)
static void	setSpaceBetweenCharacters(int value)
static void	setUseCanBreakProperty(boolean value)
static void	setUseNewPageCommandInsteadOfNewSection(boolean useNewPageCommandInsteadOfNewSection)
static void	setUsePageRefField(boolean value)
static void	setUseTemplatePageSize(boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExportOptions.Rtf

public ExportOptions.Rtf()

Method Detail

isUseNewPageCommandInsteadOfNewSection

public static boolean isUseNewPageCommandInsteadOfNewSection()

A value indicating whether it is necessary to use NewPage command instead of NewSection

Returns:

the useNewPageCommandInsteadOfNewSection

setUseNewPageCommandInsteadOfNewSection

public static void setUseNewPageCommandInsteadOfNewSection(boolean useNewPageCommandInsteadOfNewSection)

Parameters:

useNewPageCommandInsteadOfNewSection - the useNewPageCommandInsteadOfNewSection to set

getBottomMarginCorrection

public static int getBottomMarginCorrection()

A value of bottom margin correction

Returns:

the bottomMarginCorrection

setBottomMarginCorrection

public static void setBottomMarginCorrection(int bottomMarginCorrection)

Parameters:

bottomMarginCorrection - the bottomMarginCorrection to set

getForceEmptyCellsOptimization

public static boolean getForceEmptyCellsOptimization()

Gets or sets a value indicating a forcing of empty cells optimization.

setForceEmptyCellsOptimization

public static void setForceEmptyCellsOptimization(boolean forceEmptyCellsOptimization)

getUsePageRefField

public static boolean getUsePageRefField()

Gets or sets a value indicating whether it is necessary to use PAGEREF field of MS-Word.

setUsePageRefField

public static void setUsePageRefField(boolean value)

getConvertDigitsToArabic

public static boolean getConvertDigitsToArabic()

Gets or sets a value, which indicates whether it is necessary to convert all digits to arabic digits.

setConvertDigitsToArabic

public static void setConvertDigitsToArabic(boolean value)

getArabicDigitsType

public static StiArabicDigitsType getArabicDigitsType()

Gets or sets a value indicating a current arabic type of digits.

setArabicDigitsType

public static void setArabicDigitsType(StiArabicDigitsType value)

getDivideSegmentPages

public static boolean getDivideSegmentPages()

When Rtf exporting segmented pages will be forcibly broken in order of chosen page format.

setDivideSegmentPages

public static void setDivideSegmentPages(boolean value)

getUseTemplatePageSize

public static boolean getUseTemplatePageSize()

When Rtf exporting segmented pages will be forcibly use the page size from template. This property work only if DivideSegmentPages=false.

setUseTemplatePageSize

public static void setUseTemplatePageSize(boolean value)

getLineHeightExactly

public static boolean getLineHeightExactly()

Gets or sets a value indicating a line height mode - "exactly" or "at least".

setLineHeightExactly

public static void setLineHeightExactly(boolean value)

getForceLineHeight

public static boolean getForceLineHeight()

Gets or sets a value indicating a forcing of line height.

setForceLineHeight

public static void setForceLineHeight(boolean value)

getRemoveEmptySpaceAtBottom

public static boolean getRemoveEmptySpaceAtBottom()

Gets or sets a value indicating whether it is necessary to remove empty space at the bottom of page

setRemoveEmptySpaceAtBottom

public static void setRemoveEmptySpaceAtBottom(boolean value)

getLineSpacing

public static double getLineSpacing()

Gets or sets a value of line spacing

setLineSpacing

public static void setLineSpacing(double value)

getRightMarginCorrection

public static int getRightMarginCorrection()

Gets or sets a value of right margin correction

setRightMarginCorrection

public static void setRightMarginCorrection(int value)

getDivideBigCells

public static boolean getDivideBigCells()

When Rtf exporting big cells will be divided into small cells.

setDivideBigCells

public static void setDivideBigCells(boolean value)

getUseCanBreakProperty

public static boolean getUseCanBreakProperty()

Gets or sets a value indicating whether it is necessary to use CanBreak property of components.

setUseCanBreakProperty

public static void setUseCanBreakProperty(boolean value)

getSpaceBetweenCharacters

public static int getSpaceBetweenCharacters()

Gets or sets a value of expansion or compression of the space between characters in twips; a negative value compresses.

setSpaceBetweenCharacters

public static void setSpaceBetweenCharacters(int value)