Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: text ::

service ViewSettings
Description
provides access to the settings of the controller of a text document.

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
Properties' Summary
boolean
ShowAnnotations
If this property is true, annotations (notes) are visible.  
boolean
ShowBreaks
If this property is true, paragraph line breaks are visible.  
boolean
ShowDrawings
If this property is true, shapes are visible.  
boolean
ShowFieldCommands
If this property is true, text fields are shown with their commands; otherwise the content is visible.  
boolean
ShowFootnoteBackground
If this property is true, footnotes symbols are displayed with gray background.  
boolean
ShowGraphics
If this property is true, graphic objects are visible.  
boolean
ShowHiddenParagraphs
If this property is true, hidden paragraghs are displayed.  
boolean
ShowHiddenText
If this property is true, hidden text is displayed.  
boolean
ShowRulers
ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.  
boolean
ShowHoriRuler
If this property is true and the property ShowRulers is true, the horizontal ruler is displayed.  
boolean
ShowHoriScrollBar
If this property is true and the property ShowRulers is true, the horizontal scroll bar is displayed.  
boolean
ShowIndexMarkBackground
If this property is true, index marks are displayed with gray background.  
boolean
ShowParaBreaks
If this property is true, paragraph breaks are visible.  
boolean
ShowProtectedSpaces
If this property is true, protected spaces (hard spaces) are displayed with gray background.  
boolean
ShowSoftHyphens
If this property is true, soft hyphens are displayed with gray background.  
boolean
ShowSpaces
If this property is true, spaces are displayed with dots.  
boolean
ShowTableBoundaries
If this property is true, table boundaries are displayed.  
boolean
ShowTables
If this property is true, tables are visible.  
boolean
ShowTabstops
If this property is true, tab stops are visible.  
boolean
ShowTextBoundaries
If this property is true, text boundaries are displayed.  
boolean
ShowTextFieldBackground
If this property is true, text fields are displayed with gray background.  
boolean
ShowVertRuler
If this property is true, the vertical ruler is displayed.  
boolean
ShowVertScrollBar
If this property is true, the vertical scroll bar is displayed.  
boolean
SmoothScrolling
If this property is true, smooth scrolling is active.  
boolean
SolidMarkHandles
If this property is true, handles of drawing objects are visible.  
boolean
IsVertRulerRightAligned
If this property is true, the vertical ruler is aligned to the right side of the view and the vertical scrollbar is on the left.  
boolean
ShowOnlineLayout
If this property is true the document will be displayed as if it were a HTML document.  
short
ZoomType
This property defines the zoom type for the document.  
short
ZoomValue
Defines the zoom value to use. Valid only if the ZoomType is set to BY_VALUE.  
boolean
IsExecuteHyperlinks
[ OPTIONAL ]
If this property is true hyperlinks in the document are executed (loaded) on mouse click. Otherwise they are handled like normal text.  
boolean
IsRasterVisible
[ OPTIONAL ]
Specifies whether to display the grid or not  
boolean
IsSnapToRaster
[ OPTIONAL ]
Specifies whether to move frames, drawing elements, and form functions only between grid points.  
long
RasterSubdivisionX
[ OPTIONAL ]
Specifies the number of intervals between grid points on the X-axis.  
long
RasterSubdivisionY
[ OPTIONAL ]
Specifies the number of intervals between grid points on the Y-axis.  
long
RasterResolutionX
[ OPTIONAL ]
Defines the unit of measure for the spacing between grid points on the X-axis.  
long
RasterResolutionY
[ OPTIONAL ]
Defines the unit of measure for the spacing between grid points on the Y-axis.  
boolean
ShowHiddenCharacters
[ OPTIONAL ]
If this property is true, hidden characters are displayed  
boolean
ShowNonprintingCharacters
[ OPTIONAL ]
If this property is true, the settings of nonprinting characters are applied.  
long
HorizontalRulerMetric
[ OPTIONAL ]
metric unit of the horizontal ruler  
long
VerticalRulerMetric
[ OPTIONAL ]
metric unit of the vertical ruler  
boolean
ShowContentTips
[ OPTIONAL ]
If this property is true, tips for document content are shown, typically in a help balloon when the mouse is over the content.  
boolean
ShowScrollBarTips
[ OPTIONAL ]
If this property is true, and the scroll bar is shown, a tool tip is displayed while scrolling.  
Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
Properties' Details
ShowAnnotations
boolean ShowAnnotations;
Description
If this property is true, annotations (notes) are visible.
ShowBreaks
boolean ShowBreaks;
Description
If this property is true, paragraph line breaks are visible.
ShowDrawings
boolean ShowDrawings;
Description
If this property is true, shapes are visible.
ShowFieldCommands
boolean ShowFieldCommands;
Description
If this property is true, text fields are shown with their commands; otherwise the content is visible.
ShowFootnoteBackground
boolean ShowFootnoteBackground;
Description
If this property is true, footnotes symbols are displayed with gray background.
ShowGraphics
boolean ShowGraphics;
Description
If this property is true, graphic objects are visible.
ShowHiddenParagraphs
boolean ShowHiddenParagraphs;
Description
If this property is true, hidden paragraghs are displayed.
ShowHiddenText
boolean ShowHiddenText;
Description
If this property is true, hidden text is displayed.
ShowRulers
boolean ShowRulers;
Description
ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
ShowHoriRuler
boolean ShowHoriRuler;
Description
If this property is true and the property ShowRulers is true, the horizontal ruler is displayed.
ShowHoriScrollBar
boolean ShowHoriScrollBar;
Description
If this property is true and the property ShowRulers is true, the horizontal scroll bar is displayed.
ShowIndexMarkBackground
boolean ShowIndexMarkBackground;
Description
If this property is true, index marks are displayed with gray background.
ShowParaBreaks
boolean ShowParaBreaks;
Description
If this property is true, paragraph breaks are visible.
ShowProtectedSpaces
boolean ShowProtectedSpaces;
Description
If this property is true, protected spaces (hard spaces) are displayed with gray background.
ShowSoftHyphens
boolean ShowSoftHyphens;
Description
If this property is true, soft hyphens are displayed with gray background.
ShowSpaces
boolean ShowSpaces;
Description
If this property is true, spaces are displayed with dots.
ShowTableBoundaries
boolean ShowTableBoundaries;
Description
If this property is true, table boundaries are displayed.
ShowTables
boolean ShowTables;
Description
If this property is true, tables are visible.
ShowTabstops
boolean ShowTabstops;
Description
If this property is true, tab stops are visible.
ShowTextBoundaries
boolean ShowTextBoundaries;
Description
If this property is true, text boundaries are displayed.
ShowTextFieldBackground
boolean ShowTextFieldBackground;
Description
If this property is true, text fields are displayed with gray background.
ShowVertRuler
boolean ShowVertRuler;
Description
If this property is true, the vertical ruler is displayed.
ShowVertScrollBar
boolean ShowVertScrollBar;
Description
If this property is true, the vertical scroll bar is displayed.
SmoothScrolling
boolean SmoothScrolling;
Description
If this property is true, smooth scrolling is active.
SolidMarkHandles
boolean SolidMarkHandles;
Description
If this property is true, handles of drawing objects are visible.
IsVertRulerRightAligned
boolean IsVertRulerRightAligned;
Description
If this property is true, the vertical ruler is aligned to the right side of the view and the vertical scrollbar is on the left.
ShowOnlineLayout
boolean ShowOnlineLayout;
Description
If this property is true the document will be displayed as if it were a HTML document.
ZoomType
short ZoomType;
Description
This property defines the zoom type for the document.
See also
::com::sun::star::view::DocumentZoomType
ZoomValue
short ZoomValue;
Description
Defines the zoom value to use. Valid only if the ZoomType is set to BY_VALUE.
IsExecuteHyperlinks
boolean IsExecuteHyperlinks;
Usage Restrictions
optional
Description
If this property is true hyperlinks in the document are executed (loaded) on mouse click. Otherwise they are handled like normal text.
IsRasterVisible
boolean IsRasterVisible;
Usage Restrictions
optional
Description
Specifies whether to display the grid or not
Since
OOo 2.0
IsSnapToRaster
boolean IsSnapToRaster;
Usage Restrictions
optional
Description
Specifies whether to move frames, drawing elements, and form functions only between grid points.
Since
OOo 2.0
RasterSubdivisionX
long RasterSubdivisionX;
Usage Restrictions
optional
Description
Specifies the number of intervals between grid points on the X-axis.

The value must be greater or equal to 0, and the application may enforce an upper bound for the value.

Since
OOo 2.0
Throws
com::sun::star::lang::IllegalArgumentException if the value is out of bounds.
RasterSubdivisionY
long RasterSubdivisionY;
Usage Restrictions
optional
Description
Specifies the number of intervals between grid points on the Y-axis.

The value must be greater or equal to 0, and the application may enforce an upper bound for the value.

Since
OOo 2.0
Throws
com::sun::star::lang::IllegalArgumentException if the value is out of bounds.
RasterResolutionX
long RasterResolutionX;
Usage Restrictions
optional
Description
Defines the unit of measure for the spacing between grid points on the X-axis.

The value must be greater than 0. The application may enforce more restricting bounds for the value.

Since
OOo 2.0
Throws
com::sun::star::lang::IllegalArgumentException if the value is out of bounds.
RasterResolutionY
long RasterResolutionY;
Usage Restrictions
optional
Description
Defines the unit of measure for the spacing between grid points on the Y-axis.

The value must be greater than 0. The application may enforce more restricting bounds for the value.

Since
OOo 2.0
Throws
com::sun::star::lang::IllegalArgumentException if the value is out of bounds.
ShowHiddenCharacters
boolean ShowHiddenCharacters;
Usage Restrictions
optional
Description
If this property is true, hidden characters are displayed
Since
OOo 3.0
ShowNonprintingCharacters
boolean ShowNonprintingCharacters;
Usage Restrictions
optional
Description
If this property is true, the settings of nonprinting characters are applied.

This option controls the use of the settings ShowHiddenCharacters, ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks

Since
OOo 3.0
HorizontalRulerMetric
long HorizontalRulerMetric;
Usage Restrictions
optional
Description
metric unit of the horizontal ruler

Uses values ::com::sun::star::awt::FieldUnit

Since
OOo 3.1
VerticalRulerMetric
long VerticalRulerMetric;
Usage Restrictions
optional
Description
metric unit of the vertical ruler

Uses values from ::com::sun::star::awt::FieldUnit

Since
OOo 3.1
ShowContentTips
boolean ShowContentTips;
Usage Restrictions
optional
Description
If this property is true, tips for document content are shown, typically in a help balloon when the mouse is over the content.
Since
Apache OpenOffice 4.0
ShowScrollBarTips
boolean ShowScrollBarTips;
Usage Restrictions
optional
Description
If this property is true, and the scroll bar is shown, a tool tip is displayed while scrolling.
Since
Apache OpenOffice 4.0

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.