View (object)

<< Click to Display Table of Contents >>

View (object)

Access paths:

Application à Windows à Item à View

Application à ActiveWindow à View

Application à Documents à Item à ActiveWindow à View

Application à ActiveDocument à ActiveWindow à View

 1  Description

The View object contains a range of settings for the presentation on screen. It is a child object of the Window object.

Note: The presentation settings provided by the View object are specific to the document window – i.e., each document window has its own settings. The global settings (valid for all documents) can be found in the objects Application and Options.

 2  Access to the object

Each document window has exactly one instance of the View object. It is accessed through the object pointer View in the Window object:

' Show all special characters (tabs, etc.) in the active window

tm.ActiveWindow.View.ShowAll = True

 3  Properties, objects, collections and methods

Properties:

Type

Mode

FieldShading

HighlightComments

RevisionsBalloonSide

RevisionsBalloonWidth

CommentsPaneAutoShow

ShowHiddenText

PrintHiddenText

ShowParagraphs

ShowSpaces

ShowTabs

ShowAll

ShowBookmarks

ShowTextBoundaries

WrapToWindow

 

Objects:

Zoom Zoom

Application Application

Parent Window

Type (property)

Data type: Long (TmViewType)

Gets or sets the view type of the document window. The possible values are:

tmPrintView         = 0 ' Normal view

tmMasterView        = 1 ' Master page view

tmNormalView        = 2 ' Concept view

tmOutlineView       = 3 ' Outline view

Mode (property)

Data type: Long (TmViewMode)

Gets or sets the view mode of the document window. The possible values are:

tmViewModeText      = 0 ' Editing mode

tmViewModeObject    = 1 ' Object mode

If you set this property to tmViewModeObject while the document window view (see above) is set to tmNormalView (ribbon command View group | Views | Concept) or tmOutlineView (ribbon command View | Views group | Outline), TextMaker automatically switches to tmPrintView because object mode is not available in these views.

FieldShading (property)

Data type: Long (TmFieldShading)

Gets or sets the setting "Shade fields" on the View tab in the dialog box of the ribbon command File | Properties. The possible values are:

tmFieldShadingNever   = 0 ' Do not shade fields in gray

tmFieldShadingAlways  = 1 ' Shade fields in gray

HighlightComments (property)

Data type: Boolean

Gets or sets the property of the document window whether comments in the document are color-highlighted (True or False).

RevisionsBalloonSide (property)

Data type: Long (TmRevisionsBalloonMargin)

Gets or sets the position where comments appear inside the document window. The possible values are:

tmRightMargin   = 0 ' right

tmLeftMargin    = 1 ' left

tmOuterMargin   = 2 ' outside

tmInnerMargin   = 3 ' inside

RevisionsBalloonWidth (property)

Data type: Long

Gets or sets the width of the comment field in the document window, measured in points (1 point corresponds to 1/72 inches).

CommentsPaneAutoShow (property)

Data type: Boolean

Gets or sets the setting of the document window whether the comment field should be automatically shown (True or False).

ShowHiddenText (property)

Data type: Boolean

Gets or sets the setting of the document window whether hidden text should be shown or not (True or False).

PrintHiddenText (property)

Data type: Boolean

Gets or sets the setting of the document window whether hidden text should be printed or not (True or False).

ShowParagraphs (property)

Data type: Boolean

Gets or sets the setting of the document window whether paragraph marks (¶) should be shown or not (True or False).

ShowSpaces (property)

Data type: Boolean

Gets or sets the setting of the document window whether space characters should be displayed with a small point (·) or not (True or False).

ShowTabs (property)

Data type: Boolean

Gets or sets the setting of the document window whether tab stops should be displayed with an arrow (→) or not (True or False).

ShowAll (property)

Data type: Boolean

Gets or sets the setting of the document window whether all unprintable characters (paragraph signs, tab stops, space characters) should be displayed or not (True or False).

ShowBookmarks (property)

Data type: Boolean

Gets or sets the setting of the document window whether bookmarks should be shown or not (True or False).

ShowTextBoundaries (property)

Data type: Boolean

Gets or sets the setting of the document whether the page borders should be displayed as dotted lines or not (True or False).

WrapToWindow (property)

Data type: Boolean

Gets or sets the setting of the document window whether the text should be wrapped at the window border or not (True or False).

Zoom (pointer to object)

Data type: Object

Returns the Zoom object which contains the zoom level setting of the document window.

Application (pointer to object)

Data type: Object

Returns the Application object.

Parent (pointer to object)

Data type: Object

Returns the parent object, i.e. an object of the type Window.