Options Class

Create a new Options object with default values.

Breaks into debugger at a particular time frame in the render sequence. For internal use only.

Break into debugger at a second time frame in the render sequence as measured from BreakAtTimeFrame. For internal use only.

Break into debugger at the point a particular frame is adopted. For internal use only.

Break into debugger if the conversion of DOC to DOCX fails. For internal use only.

Break into debugger at the point a particular frame is created. For internal use only.

Break into debugger at the point a particular frame is popped off the parsing stack.

Break into debugger at the point a particular frame is reflowed. For internal use only.

Break into debugger at the point a particular frame is rendered. For internal use only.

Enable clipping.

Clipping regions outlined.

The action that should be performed when a corrupt image is encountered.

The default value is Action.Ignore which means that a blank space will be left where the element should be.

Draw horizontal lines to show the position of the document grid. The grid is used for the precision layout of East Asian characters.

Draw guides to show the locations of the page margins.

Draw annotations to show how paths are constructed and where the end and control points lie.

Show pilcrows - paragraph markers.

Whether to draw signature strings even if the validity of the signature is uncertain.

Show spaces as dots.

Show tabs as arrows.

Draw frames and annotations for types of frames contained in this HashSet.

Draw horizontal lines at intervals of 50 points.

Allows you to override the value of all date and time fields in the document.

This can be useful for test cases where you want the output to be identical rather than changing with date.

Fill spaces on page that are occupied by floating objects. If these objects are invisible the marks can be useful.

Whether to format the input XML using indents and new lines to make it more readable. If you want to take advantage of the Frame.LineNumber property you will typically want the XML formatted in this way.

Draw a frame round each atomic text fragment.

Whether to load and use fonts embedded in the source document.

A timeout for the loading of the document.

If the document fails to load and reflow within the specified time then a TimeoutException will be raised.

Some operations cannot be halted immediately, so the exception may not be raised at the exact point of the timeout. In generally the two will be fairly close - less than a second apart - but conceivably the delay could be up to a minute or so.

The default timeout is ten minutes which should be enough for all but the very largest documents.

The maximum number of times that an individual frame may be reflowed.

A timeout for the loading of metafiles within the document.

The action that should be performed when an error is encountered during rendering of multiple pages.

The default value is Action.Ignore which means that rendering exceptions will be ignored. Only load exceptions will be rethrown.

If the value Action.ErrorOnLoad is used, any exception raised at any point during import will be immediately be rethrown.

If the value Action.ErrorOnRender is used, an attempt will be made to render the whole document, keeping track of any errors. If an error is encountered during load then this will be rethrown. If errors are encountered duging page rendering, these will be collected and rethrown in the form of an AggregateException.

Override the opacity of the page background color.

The action that should be performed when a reflow error is encountered.

The default value is Action.ErrorOnLoad which means that an exception will be raised as soon as a reflow error is detected.

The value Action.ErrorOnRender is not applicable to this property and it will behave the same ways as Action.ErrorOnLoad.

The count at which reflow should be stopped.

By default this value is null in which case reflow will be stopped when it is complete. However by setting this value it is possible to see the state of the document at an earlier point in the reflow.

Whether to display pages which are completely blank.

Whether to track the the number of times a Frame has been requested to reflow.

If set, the count will be availalable via the Frame.ReflowCount.

Setting this property also allows the render to tell the difference betwen Frames which have been reflowed and those that have not.

This means that with this property set it can render partially reflowed pages in a more sensible way.

Whether to track the current reflow state via the ReflowState.Current property.

The action that should be performed when an unrecognised drawing type is encountered.

The default value is Action.Ignore which means that a blank space will be left where the element should be.