com.aspose.words

Class LayoutOptions

java.lang.Object

com.aspose.words.LayoutOptions

All Implemented Interfaces:

java.lang.Cloneable

public class LayoutOptions
extends java.lang.Object
implements java.lang.Cloneable

Holds the options that allow controlling the document layout process.

To learn more, visit the Converting to Fixed-page Format documentation article.

You do not create instances of this class directly. Use the Document.getLayoutOptions() property to access layout options for this document.

Note that after changing any of the options present in this class, Document.updatePageLayout() method should be called in order for the changed options to be applied to the layout.

Method Summary

Modifier and Type	Method and Description
IPageLayoutCallback	getCallback() Gets IPageLayoutCallback implementation used by page layout model.
int	getCommentDisplayMode() Gets the way comments are rendered.
int	getContinuousSectionPageNumberingRestart() Gets the mode of behavior for computing page numbers when a continuous section restarts the page numbering.
boolean	getIgnorePrinterMetrics() Gets indication of whether the "Use printer metrics to lay out document" compatibility option is ignored.
RevisionOptions	getRevisionOptions() Gets revision options.
boolean	getShowHiddenText() Gets indication of whether hidden text in the document is rendered.
boolean	getShowParagraphMarks() Gets indication of whether paragraph marks are rendered.
ITextShaperFactory	getTextShaperFactory() Gets ITextShaperFactory implementation used for Advanced Typography rendering features.
protected java.lang.Object	memberwiseClone()
void	setCallback(IPageLayoutCallback value) Sets IPageLayoutCallback implementation used by page layout model.
void	setCommentDisplayMode(int value) Sets the way comments are rendered.
void	setContinuousSectionPageNumberingRestart(int value) Sets the mode of behavior for computing page numbers when a continuous section restarts the page numbering.
void	setIgnorePrinterMetrics(boolean value) Sets indication of whether the "Use printer metrics to lay out document" compatibility option is ignored.
void	setShowHiddenText(boolean value) Sets indication of whether hidden text in the document is rendered.
void	setShowParagraphMarks(boolean value) Sets indication of whether paragraph marks are rendered.
void	setTextShaperFactory(ITextShaperFactory value) Sets ITextShaperFactory implementation used for Advanced Typography rendering features.

Methods inherited from class java.lang.Object

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

Method Detail

getRevisionOptions

public RevisionOptions getRevisionOptions()

Gets revision options.

Returns:

Revision options.

getShowHiddenText

public boolean getShowHiddenText()

Gets indication of whether hidden text in the document is rendered. Default is False. This property affects all hidden content, not just text.

Returns:

Indication of whether hidden text in the document is rendered.

setShowHiddenText

public void setShowHiddenText(boolean value)

Sets indication of whether hidden text in the document is rendered. Default is False. This property affects all hidden content, not just text.

Parameters:

value - Indication of whether hidden text in the document is rendered.

getShowParagraphMarks

public boolean getShowParagraphMarks()

Gets indication of whether paragraph marks are rendered. Default is False.

Returns:

Indication of whether paragraph marks are rendered.

setShowParagraphMarks

public void setShowParagraphMarks(boolean value)

Sets indication of whether paragraph marks are rendered. Default is False.

Parameters:

value - Indication of whether paragraph marks are rendered.

getCommentDisplayMode

public int getCommentDisplayMode()

Gets the way comments are rendered. Default value is CommentDisplayMode.SHOW_IN_BALLOONS. Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.

Returns:

The way comments are rendered. The returned value is one of CommentDisplayMode constants.

setCommentDisplayMode

public void setCommentDisplayMode(int value)

Sets the way comments are rendered. Default value is CommentDisplayMode.SHOW_IN_BALLOONS. Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.

Parameters:

value - The way comments are rendered. The value must be one of CommentDisplayMode constants.

getTextShaperFactory

public ITextShaperFactory getTextShaperFactory()

Gets ITextShaperFactory implementation used for Advanced Typography rendering features.

Returns:

ITextShaperFactory implementation used for Advanced Typography rendering features.

setTextShaperFactory

public void setTextShaperFactory(ITextShaperFactory value)

Sets ITextShaperFactory implementation used for Advanced Typography rendering features.

Parameters:

value - ITextShaperFactory implementation used for Advanced Typography rendering features.

getCallback

public IPageLayoutCallback getCallback()

Gets IPageLayoutCallback implementation used by page layout model.

Returns:

IPageLayoutCallback implementation used by page layout model.

setCallback

public void setCallback(IPageLayoutCallback value)

Sets IPageLayoutCallback implementation used by page layout model.

Parameters:

value - IPageLayoutCallback implementation used by page layout model.

getIgnorePrinterMetrics

public boolean getIgnorePrinterMetrics()

Gets indication of whether the "Use printer metrics to lay out document" compatibility option is ignored. Default is True.

Returns:

Indication of whether the "Use printer metrics to lay out document" compatibility option is ignored.

setIgnorePrinterMetrics

public void setIgnorePrinterMetrics(boolean value)

Sets indication of whether the "Use printer metrics to lay out document" compatibility option is ignored. Default is True.

Parameters:

value - Indication of whether the "Use printer metrics to lay out document" compatibility option is ignored.

getContinuousSectionPageNumberingRestart

public int getContinuousSectionPageNumberingRestart()

Gets the mode of behavior for computing page numbers when a continuous section restarts the page numbering. The default value is ContinuousSectionRestart.ALWAYS. It matches the behavior of MS Word 2019 which was the latest version at the moment the option was introduced. Older page numbering logic demonstrated by MS Word 2016 is available via this option. Please ContinuousSectionRestart for the behavior description.

Returns:

The mode of behavior for computing page numbers when a continuous section restarts the page numbering. The returned value is one of ContinuousSectionRestart constants.

setContinuousSectionPageNumberingRestart

public void setContinuousSectionPageNumberingRestart(int value)

Sets the mode of behavior for computing page numbers when a continuous section restarts the page numbering. The default value is ContinuousSectionRestart.ALWAYS. It matches the behavior of MS Word 2019 which was the latest version at the moment the option was introduced. Older page numbering logic demonstrated by MS Word 2016 is available via this option. Please ContinuousSectionRestart for the behavior description.

Parameters:

value - The mode of behavior for computing page numbers when a continuous section restarts the page numbering. The value must be one of ContinuousSectionRestart constants.

memberwiseClone

protected java.lang.Object memberwiseClone()