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

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

Example:

Shows how to make sure the document is displayed at 50% zoom when opened in Microsoft Word.
Document doc = new Document(getMyDir() + "Document.doc");

// We can set the zoom factor to a percentage
doc.getViewOptions().setViewType(ViewType.PAGE_LAYOUT);
doc.getViewOptions().setZoomPercent(50);

// Or we can set the ZoomType to a different value to avoid using percentages 
Assert.assertEquals(doc.getViewOptions().getZoomType(), ZoomType.NONE);

doc.save(getArtifactsDir() + "ViewOptions.SetZoom.doc");
See Also:
Document, Document.ViewOptions

Property Getters/Setters Summary
booleangetDisplayBackgroundShape()
void
           Controls display of the background shape in print layout view.
booleangetDoNotDisplayPageBoundaries()
void
           Turns off display of the space between the top of the text and the top edge of the page.
booleangetFormsDesign()
void
setFormsDesign(booleanvalue)
           Specifies whether the document is in forms design mode.
intgetViewType()
void
setViewType(intvalue)
           Controls the view mode in Microsoft Word. The value of the property is ViewType integer constant.
intgetZoomPercent()
void
setZoomPercent(intvalue)
           Gets or sets the percentage (between 10 and 500) at which you want to view your document.
intgetZoomType()
void
setZoomType(intvalue)
           Gets or sets a zoom value based on the size of the window. The value of the property is ZoomType integer constant.
 

    • Property Getters/Setters Detail

      • getDisplayBackgroundShape/setDisplayBackgroundShape

        public boolean getDisplayBackgroundShape() / public void setDisplayBackgroundShape(boolean value)
        
        Controls display of the background shape in print layout view.

        Example:

        Shows how to hide/display document background images in view options.
        // Create a new document from an html string
        final String HTML = "\r\n<html>\r\n<body style='background-color: blue'>\r\n<p>Hello world!</p>\r\n</body>\r\n</html>";
        
        Document doc = new Document(new ByteArrayInputStream(HTML.getBytes()));
        
        // The source for the document has a flat color background, the presence of which will turn on the DisplayBackgroundShape flag
        // We can disable it like this
        doc.getViewOptions().setDisplayBackgroundShape(false);
        
        doc.save(getArtifactsDir() + "ViewOptions.DisplayBackgroundShape.docx");
      • getDoNotDisplayPageBoundaries/setDoNotDisplayPageBoundaries

        public boolean getDoNotDisplayPageBoundaries() / public void setDoNotDisplayPageBoundaries(boolean value)
        
        Turns off display of the space between the top of the text and the top edge of the page.

        Example:

        Shows how to hide vertical whitespace and headers/footers in view options.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert content spanning 3 pages
        builder.writeln("Paragraph 1, Page 1");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Paragraph 2, Page 2");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Paragraph 3, Page 3");
        
        // Insert a header and a footer
        builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
        builder.writeln("Header");
        builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
        builder.writeln("Footer");
        
        // In this case we have a lot of space taken up by quite a little amount of content
        // In older versions of Microsoft Word, we can hide headers/footers and compact vertical whitespace of pages
        // to give the document's main body content some flow by setting this flag
        doc.getViewOptions().setDoNotDisplayPageBoundaries(true);
        
        doc.save(getArtifactsDir() + "ViewOptions.DisplayPageBoundaries.doc");
      • getFormsDesign/setFormsDesign

        public boolean getFormsDesign() / public void setFormsDesign(boolean value)
        
        Specifies whether the document is in forms design mode.

        Currently works only for documents in WordML format.

        Example:

        Shows how to save to a .wml document while applying save options.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        WordML2003SaveOptions options = new WordML2003SaveOptions();
        {
            options.setSaveFormat(SaveFormat.WORD_ML);
            options.setMemoryOptimization(true);
            options.setPrettyFormat(true);
        }
        
        // Enables forms design mode in WordML documents
        doc.getViewOptions().setFormsDesign(true);
        
        doc.save(getArtifactsDir() + "ViewOptions.FormsDesign.xml", options);
      • getViewType/setViewType

        public int getViewType() / public void setViewType(int value)
        
        Controls the view mode in Microsoft Word. The value of the property is ViewType integer constant.

        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.

        Example:

        Shows how to make sure the document is displayed at 50% zoom when opened in Microsoft Word.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // We can set the zoom factor to a percentage
        doc.getViewOptions().setViewType(ViewType.PAGE_LAYOUT);
        doc.getViewOptions().setZoomPercent(50);
        
        // Or we can set the ZoomType to a different value to avoid using percentages 
        Assert.assertEquals(doc.getViewOptions().getZoomType(), ZoomType.NONE);
        
        doc.save(getArtifactsDir() + "ViewOptions.SetZoom.doc");
      • getZoomPercent/setZoomPercent

        public int getZoomPercent() / public void setZoomPercent(int value)
        
        Gets or 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.

        Example:

        Shows how to make sure the document is displayed at 50% zoom when opened in Microsoft Word.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // We can set the zoom factor to a percentage
        doc.getViewOptions().setViewType(ViewType.PAGE_LAYOUT);
        doc.getViewOptions().setZoomPercent(50);
        
        // Or we can set the ZoomType to a different value to avoid using percentages 
        Assert.assertEquals(doc.getViewOptions().getZoomType(), ZoomType.NONE);
        
        doc.save(getArtifactsDir() + "ViewOptions.SetZoom.doc");
      • getZoomType/setZoomType

        public int getZoomType() / public void setZoomType(int value)
        
        Gets or sets a zoom value based on the size of the window. The value of the property is ZoomType integer constant.

        Example:

        Shows how to make sure the document is displayed at 50% zoom when opened in Microsoft Word.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // We can set the zoom factor to a percentage
        doc.getViewOptions().setViewType(ViewType.PAGE_LAYOUT);
        doc.getViewOptions().setZoomPercent(50);
        
        // Or we can set the ZoomType to a different value to avoid using percentages 
        Assert.assertEquals(doc.getViewOptions().getZoomType(), ZoomType.NONE);
        
        doc.save(getArtifactsDir() + "ViewOptions.SetZoom.doc");