com.aspose.words

Class ReportBuildOptions

java.lang.Object

com.aspose.words.ReportBuildOptions

public class ReportBuildOptions
extends java.lang.Object

Specifies options controlling behavior of ReportingEngine while building a report.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_MISSING_MEMBERS Specifies that missing object members should be treated as null literals by the engine.
static int	INLINE_ERROR_MESSAGES Specifies that the engine should inline template syntax error messages into output documents.
static int	length
static int	NONE Specifies default options.
static int	REMOVE_EMPTY_PARAGRAPHS Specifies that the engine should remove paragraphs becoming empty after template syntax tags are removed or replaced with empty values.
static int	RESPECT_JPEG_EXIF_ORIENTATION Specifies that the engine should use EXIF image orientation values to appropriately rotate inserted JPEG images.
static int	UPDATE_FIELDS_SYNTAX_AWARE Specifies that the engine should ignore template syntax in field results and update fields after a report is built.
static int	USE_LEGACY_HEADER_FOOTER_VISITING Specifies that the engine should visit section child nodes (headers, footers, bodies) in an order compatible with Aspose.Words versions prior 21.9.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String reportBuildOptionsName)
static int	fromNames(java.util.Set reportBuildOptionsNames)
static java.lang.String	getName(int reportBuildOptions)
static java.util.Set	getNames(int reportBuildOptions)
static int[]	getValues()
static java.lang.String	toString(int reportBuildOptions)
static java.lang.String	toStringSet(int attr)

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static int NONE

Specifies default options.

ALLOW_MISSING_MEMBERS

public static int ALLOW_MISSING_MEMBERS

Specifies that missing object members should be treated as null literals by the engine. This option affects only access to instance (that is, non-static) object members and extension methods. If this option is not set, the engine throws an exception when encounters a missing object member.

REMOVE_EMPTY_PARAGRAPHS

public static int REMOVE_EMPTY_PARAGRAPHS

Specifies that the engine should remove paragraphs becoming empty after template syntax tags are removed or replaced with empty values.

INLINE_ERROR_MESSAGES

public static int INLINE_ERROR_MESSAGES

Specifies that the engine should inline template syntax error messages into output documents. If this option is not set, the engine throws an exception when encounters a syntax error.

USE_LEGACY_HEADER_FOOTER_VISITING

public static int USE_LEGACY_HEADER_FOOTER_VISITING

Specifies that the engine should visit section child nodes (headers, footers, bodies) in an order compatible with Aspose.Words versions prior 21.9.

Remarks:

By default, the engine treats headers and footers as if they were linked to section breaks. That is, when visiting section child nodes, a body is visited first and only then, headers and footers are visited. This agrees with Microsoft Word behavior when copy-pasting or removing multi-section contents and produces more correct results in most scenarios.

Prior to Aspose.Words 21.9, the engine used another visiting order: Section child nodes were visited in an order they appear in a document. Apply this value to ReportingEngine.getOptions() / ReportingEngine.setOptions(int) if compatibility with older versions of Aspose.Words is required.

RESPECT_JPEG_EXIF_ORIENTATION

public static int RESPECT_JPEG_EXIF_ORIENTATION

Specifies that the engine should use EXIF image orientation values to appropriately rotate inserted JPEG images.

UPDATE_FIELDS_SYNTAX_AWARE

public static int UPDATE_FIELDS_SYNTAX_AWARE

Specifies that the engine should ignore template syntax in field results and update fields after a report is built.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int reportBuildOptions)

getNames

public static java.util.Set getNames(int reportBuildOptions)

toString

public static java.lang.String toString(int reportBuildOptions)

toStringSet

public static java.lang.String toStringSet(int attr)

fromName

public static int fromName(java.lang.String reportBuildOptionsName)

fromNames

public static int fromNames(java.util.Set reportBuildOptionsNames)

getValues

public static int[] getValues()