ReportBuildOptions

Inheritance: java.lang.Object

public class ReportBuildOptions

Specifies options controlling behavior of ReportingEngine while building a report.

Fields

FieldDescription
ALLOW_MISSING_MEMBERSSpecifies that missing object members should be treated as null literals by the engine.
INLINE_ERROR_MESSAGESSpecifies that the engine should inline template syntax error messages into output documents.
NONESpecifies default options.
REMOVE_EMPTY_PARAGRAPHSSpecifies that the engine should remove paragraphs becoming empty after template syntax tags are removed or replaced with empty values.
RESPECT_JPEG_EXIF_ORIENTATIONSpecifies that the engine should use EXIF \u200b\u200bimage orientation values to appropriately rotate inserted JPEG images.
UPDATE_FIELDS_SYNTAX_AWARESpecifies that the engine should ignore template syntax in field results and update fields after a report is built.
USE_LEGACY_HEADER_FOOTER_VISITINGSpecifies that the engine should visit section child nodes (headers, footers, bodies) in an order compatible with Aspose.Words versions prior 21.9.
length

Methods

MethodDescription
fromName(String reportBuildOptionsName)
fromNames(Set reportBuildOptionsNames)
getName(int reportBuildOptions)
getNames(int reportBuildOptions)
getValues()
toString(int reportBuildOptions)
toStringSet(int attr)

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.

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.

NONE

public static int NONE

Specifies default options.

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.

RESPECT_JPEG_EXIF_ORIENTATION

public static int RESPECT_JPEG_EXIF_ORIENTATION

Specifies that the engine should use EXIF \u200b\u200bimage 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.

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.

length

public static int length

fromName(String reportBuildOptionsName)

public static int fromName(String reportBuildOptionsName)

Parameters:

ParameterTypeDescription
reportBuildOptionsNamejava.lang.String

Returns: int

fromNames(Set reportBuildOptionsNames)

public static int fromNames(Set reportBuildOptionsNames)

Parameters:

ParameterTypeDescription
reportBuildOptionsNamesjava.util.Set

Returns: int

getName(int reportBuildOptions)

public static String getName(int reportBuildOptions)

Parameters:

ParameterTypeDescription
reportBuildOptionsint

Returns: java.lang.String

getNames(int reportBuildOptions)

public static Set getNames(int reportBuildOptions)

Parameters:

ParameterTypeDescription
reportBuildOptionsint

Returns: java.util.Set

getValues()

public static int[] getValues()

Returns: int[]

toString(int reportBuildOptions)

public static String toString(int reportBuildOptions)

Parameters:

ParameterTypeDescription
reportBuildOptionsint

Returns: java.lang.String

toStringSet(int attr)

public static String toStringSet(int attr)

Parameters:

ParameterTypeDescription
attrint

Returns: java.lang.String