com.aspose.words

Class ViewOptions

java.lang.Object

com.aspose.words.ViewOptions

All Implemented Interfaces:

java.lang.Cloneable

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

Provides various options that control how a document is shown in Microsoft Word.

To learn more, visit the Work with Options and Appearance of Word Documents documentation article.

See Also:

Document, Document.getViewOptions()

Method Summary

Modifier and Type	Method and Description
boolean	getDisplayBackgroundShape() Controls display of the background shape in print layout view.
boolean	getDoNotDisplayPageBoundaries() Turns off display of the space between the top of the text and the top edge of the page.
boolean	getFormsDesign() Specifies whether the document is in forms design mode.
int	getViewType() Controls the view mode in Microsoft Word.
int	getZoomPercent() Gets the percentage (between 10 and 500) at which you want to view your document.
int	getZoomType() Gets a zoom value based on the size of the window.
protected java.lang.Object	memberwiseClone()
void	setDisplayBackgroundShape(boolean value) Controls display of the background shape in print layout view.
void	setDoNotDisplayPageBoundaries(boolean value) Turns off display of the space between the top of the text and the top edge of the page.
void	setFormsDesign(boolean value) Specifies whether the document is in forms design mode.
void	setViewType(int value) Controls the view mode in Microsoft Word.
void	setZoomPercent(int value) Sets the percentage (between 10 and 500) at which you want to view your document.
void	setZoomType(int value) Sets a zoom value based on the size of the window.

Methods inherited from class java.lang.Object

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

Method Detail

getViewType

public int getViewType()

Controls the view mode in Microsoft Word.

Although Aspose.Words is able to read and write this option, its usage is application-specific. For example MS Word 2013 does not respect the value of this option.

Returns:

The corresponding int value. The returned value is one of ViewType constants.

setViewType

public void setViewType(int value)

Controls the view mode in Microsoft Word.

Although Aspose.Words is able to read and write this option, its usage is application-specific. For example MS Word 2013 does not respect the value of this option.

Parameters:

value - The corresponding int value. The value must be one of ViewType constants.

getZoomType

public int getZoomType()

Gets a zoom value based on the size of the window.

Returns:

A zoom value based on the size of the window. The returned value is one of ZoomType constants.

setZoomType

public void setZoomType(int value)

Sets a zoom value based on the size of the window.

Parameters:

value - A zoom value based on the size of the window. The value must be one of ZoomType constants.

getZoomPercent

public int getZoomPercent()

Gets the percentage (between 10 and 500) at which you want to view your document.

If value is 0 then this property uses 100 instead, else if value is less than 10 or greater than 500 this property throws.

Although Aspose.Words is able to read and write this option, its usage is application-specific. For example MS Word 2013 does not respect the value of this option.

Returns:

The percentage (between 10 and 500) at which you want to view your document.

setZoomPercent

public void setZoomPercent(int value)

Sets the percentage (between 10 and 500) at which you want to view your document.

If value is 0 then this property uses 100 instead, else if value is less than 10 or greater than 500 this property throws.

Although Aspose.Words is able to read and write this option, its usage is application-specific. For example MS Word 2013 does not respect the value of this option.

Parameters:

value - The percentage (between 10 and 500) at which you want to view your document.

getDoNotDisplayPageBoundaries

public boolean getDoNotDisplayPageBoundaries()

Turns off display of the space between the top of the text and the top edge of the page.

Returns:

The corresponding boolean value.

setDoNotDisplayPageBoundaries

public void setDoNotDisplayPageBoundaries(boolean value)

Turns off display of the space between the top of the text and the top edge of the page.

Parameters:

value - The corresponding boolean value.

getDisplayBackgroundShape

public boolean getDisplayBackgroundShape()

Controls display of the background shape in print layout view.

Returns:

The corresponding boolean value.

setDisplayBackgroundShape

public void setDisplayBackgroundShape(boolean value)

Controls display of the background shape in print layout view.

Parameters:

value - The corresponding boolean value.

getFormsDesign

public boolean getFormsDesign()

Specifies whether the document is in forms design mode.

Currently works only for documents in WordML format.

Returns:

The corresponding boolean value.

setFormsDesign

public void setFormsDesign(boolean value)

Specifies whether the document is in forms design mode.

Currently works only for documents in WordML format.

Parameters:

value - The corresponding boolean value.

memberwiseClone

protected java.lang.Object memberwiseClone()