Share via


Application Members (Word)

Represents the Microsoft Word application. The Application object includes properties and methods that return top-level objects. For example, the ActiveDocument property returns a Document object.

Methods

Name

Description

Activate

Activates the specified object.

AddAddress

Adds an entry to the address book. Each entry has values for one or more tag IDs.

AutomaticChange

Performs an AutoFormat action when there is a change suggested by the Office Assistant. If no AutoFormat action is active, this method generates an error.

BuildKeyCode

Returns a unique number for the specified key combination.

CentimetersToPoints

Converts a measurement from centimeters to points (1 cm = 28.35 points). Returns the converted measurement as a Single.

ChangeFileOpenDirectory

Sets the folder in which Word searches for documents. .

CheckGrammar

Checks a string for grammatical errors. Returns a Boolean to indicate whether the string contains grammatical errors. True if the string contains no errors.

CheckSpelling

Checks a string for spelling errors. Returns a Boolean to indicate whether the string contains spelling errors. True if the string has no spelling errors.

CleanString

Removes nonprinting characters (character codes 1 – 29) and special Word characters from the specified string or changes them to spaces (character code 32). Returns the result as a String.

CompareDocuments

Compares two documents and returns a Document object that represents the document that contains the differences between the two documents, marked using tracked changes.

DDEExecute

Sends a command or series of commands to an application through the specified dynamic data exchange (DDE) channel.

DDEInitiate

Opens a dynamic data exchange (DDE) channel to another application, and returns the channel number.

DDEPoke

Uses an open dynamic data exchange (DDE) channel to send data to an application.

DDERequest

Uses an open dynamic data exchange (DDE) channel to request information from the receiving application, and returns the information as a String.

DDETerminate

Closes the specified dynamic data exchange (DDE) channel to another application.

DDETerminateAll

Closes all dynamic data exchange (DDE) channels opened by Microsoft Word. .

DefaultWebOptions

Returns the DefaultWebOptions object that contains global application-level attributes used by Microsoft Word whenever you save a document as a Web page or open a Web page.

GetAddress

Returns an address from the default address book.

GetDefaultTheme

Returns a String that represents the name of the default theme plus the theme formatting options Microsoft Word uses for new documents, e-mail messages, or Web pages.

GetSpellingSuggestions

Returns a SpellingSuggestions collection that represents the words suggested as spelling replacements for a given word.

GoBack

Moves the insertion point among the last three locations where editing occurred in the active document (the same as pressing SHIFT+F5).

GoForward

Moves the insertion point forward among the last three locations where editing occurred in the active document.

Help

Displays installed help information.

HelpTool

Changes the pointer from an arrow to a question mark, indicating that you'll get context-sensitive Help information about the next command or screen element you click. If you click text, Word displays a box describing current paragraph and character formats. Pressing ESC turns the pointer back to an arrow.

InchesToPoints

Converts a measurement from inches to points (1 inch = 72 points). Returns the converted measurement as a Single.

Keyboard

Returns or sets the keyboard language and layout settings.

KeyboardBidi

Sets the keyboard language to a right-to-left language and the text entry direction to right-to-left.

KeyboardLatin

Sets the keyboard language to a left-to-right language and the text entry direction to left-to-right.

KeyString

Returns the key combination string for the specified keys (for example, CTRL+SHIFT+A).

LinesToPoints

Converts a measurement from lines to points (1 line = 12 points). Returns the converted measurement as a Single.

ListCommands

Creates a new document and then inserts a table of Word commands along with their associated shortcut keys and menu assignments.

LoadMasterList

Loads a bibliography source file.

LookupNameProperties

Looks up a name in the global address book list and displays the Properties dialog box, which includes information about the specified name.

MergeDocuments

Compares two documents and returns a Document object that represents the document that contains the differences between the two documents, marked using tracked changes.

MillimetersToPoints

Converts a measurement from millimeters to points (1 mm = 2.85 points). Returns the converted measurement as a Single.

Move

Positions a task window or the active document window.

NewWindow

Opens a new window with the same document as the specified window. Returns a Window object.

NextLetter

You have requested Help for a Visual Basic keyword used only on the Macintosh. For information about the NextLetter method of the Application object, consult the language reference Help included with Microsoft Office Macintosh Edition.

OnTime

Starts a background timer that runs a macro at a specified time.

OrganizerCopy

Copies the specified AutoText entry, toolbar, style, or macro project item from the source document or template to the destination document or template.

OrganizerDelete

Deletes the specified style, AutoText entry, toolbar, or macro project item from a document or template.

OrganizerRename

Renames the specified style, AutoText entry, toolbar, or macro project item in a document or template.

PicasToPoints

Converts a measurement from picas to points (1 pica = 12 points). Returns the converted measurement as a Single.

PixelsToPoints

Converts a measurement from pixels to points. Returns the converted measurement as a Single.

PointsToCentimeters

Converts a measurement from points to centimeters (1 centimeter = 28.35 points). Returns the converted measurement as a Single.

PointsToInches

Converts a measurement from points to inches (1 inch = 72 points). Returns the converted measurement as a Single.

PointsToLines

Converts a measurement from points to lines (1 line = 12 points). Returns the converted measurement as a Single.

PointsToMillimeters

Converts a measurement from points to millimeters (1 millimeter = 2.835 points). Returns the converted measurement as a Single.

PointsToPicas

Converts a measurement from points to picas (1 pica = 12 points). Returns the converted measurement as a Single.

PointsToPixels

Converts a measurement from points to pixels. Returns the converted measurement as a Single.

PrintOut

Prints all or part of the specified document.

ProductCode

Returns the Microsoft Word globally unique identifier (GUID) as a String.

PutFocusInMailHeader

Places the insertion point in the To line of the mail header if the document in the active window is an e-mail document.

Quit

Quits Microsoft Word and optionally saves or routes the open documents.

Repeat

Repeats the most recent editing action one or more times. Returns True if the commands were repeated successfully.

ResetIgnoreAll

Clears the list of words that were previously ignored during a spelling check.

Resize

Sizes the Word application window or the specified task window.

Run

Runs a Visual Basic macro.

ScreenRefresh

Updates the display on the monitor with the current information in the video memory buffer.

SetDefaultTheme

Sets a default theme for Microsoft Word to use with new documents, e-mail messages, or Web pages.

ShowClipboard

Displays the Clipboard task pane.

ShowMe

Displays the Office Assistant or the Help window when there is more information available.

SubstituteFont

Sets font-mapping options.

ToggleKeyboard

Switches the keyboard language setting between right-to-left and left-to-right languages.

Properties

Name

Description

ActiveDocument

Returns a Document object that represents the active document (the document with the focus). If there are no documents open, an error occurs. Read-only.

ActiveEncryptionSession

Returns a Long that represents the encryption session associated with the active document. Read-only.

ActivePrinter

Returns or sets the name of the active printer. Read/write String.

ActiveProtectedViewWindow

Returns a ProtectedViewWindow object that represents the active protected view window. Read-only.

ActiveWindow

Returns a Window object that represents the active window (the window with the focus). If there are no windows open, an error occurs. Read-only.

AddIns

Returns an AddIns collection that represents all available add-ins, regardless of whether they're currently loaded. Read-only.

Application

Returns an Application object that represents the Microsoft Word application.

ArbitraryXMLSupportAvailable

Returns a Boolean that represents whether Microsoft Word accepts custom XML schemas. True indicates that Word accepts custom XML schemas.

Assistance

Returns an Assistance object that represents the Microsoft Office Help Viewer. Read-only.

AutoCaptions

Returns an AutoCaptions collection that represents the captions that are automatically added when items such as tables and pictures are inserted into a document. Read-only.

AutoCorrect

Returns an AutoCorrect object that contains the current AutoCorrect options, entries, and exceptions. Read-only.

AutoCorrectEmail

Returns an AutoCorrect object that represents automatic corrections made to e-mail messages.

AutomationSecurity

Returns or sets an MsoAutomationSecurity constant that represents the security setting Microsoft Word uses when programmatically opening files. .

BackgroundPrintingStatus

Returns the number of print jobs in the background printing queue. Read-only Long.

BackgroundSavingStatus

Returns the number of files queued up to be saved in the background. Read-only Long.

Bibliography

Returns a Bibliography object that represents the bibliography references sources stored in Microsoft Word. Read-only.

BrowseExtraFileTypes

Set this property to "text/html" to allow hyperlinked HTML files to be opened in Microsoft Word (instead of the default Internet browser). Read/write String.

Browser

Returns a Browser object that represents the Select Browse Object tool on the vertical scroll bar. Read-only.

Build

Returns the version and build number of the Word application. Read-only String.

CapsLock

True if the CAPS LOCK key is turned on. Read-only Boolean.

Caption

Returns or sets the text displayed in the Title bar of the application window. Read/write String.

CaptionLabels

Returns a CaptionLabels collection that represents all the available caption labels. Read-only.

CheckLanguage

True if Microsoft Word automatically detects the language you are using as you type. Read/write Boolean.

COMAddIns

Returns a reference to the COMAddIns collection that represents all the Component Object Model (COM) add-ins currently loaded in Microsoft Word.

CommandBars

Returns a CommandBars collection that represents the menu bar and all the toolbars in Microsoft Word.

Creator

Returns a 32-bit integer that indicates the application in which the specified object was created. Read-only Long.

CustomDictionaries

Returns a Dictionaries object that represents the collection of active custom dictionaries. Read-only. .

CustomizationContext

Returns or sets a Template or Document object that represents the template or document in which changes to menu bars, toolbars, and key bindings are stored. Read/write.

DefaultLegalBlackline

True for Microsoft Word to compare and merge documents using the Legal blackline option in the Compare and Merge Documents dialog box. Read/write Boolean.

DefaultSaveFormat

Returns or sets the default format that will appear in the Save as type box in the Save As dialog box. Read/write String.

DefaultTableSeparator

Returns or sets the single character used to separate text into cells when text is converted to a table. Read/write String.

Dialogs

Returns a Dialogs collection that represents all the built-in dialog boxes in Word.Read-only.

DisplayAlerts

Returns or sets the way certain alerts and messages are handled while a macro is running. Read/write WdAlertLevel.

DisplayAutoCompleteTips

True if Word displays tips that suggest text for completing words, dates, or phrases as you type. Read/write Boolean.

DisplayDocumentInformationPanel

Returns or sets a Boolean that represents whether the document properties panel is displayed. Read/write.

DisplayRecentFiles

True if the names of recently used files are displayed on the File menu. Read/write Boolean.

DisplayScreenTips

True if comments, footnotes, endnotes, and hyperlinks are displayed as tips. Text marked as having comments is highlighted. Read/write Boolean.

DisplayScrollBars

True if Word displays a scroll bar in at least one document window. False if there are no scroll bars displayed in any window. Read/write Boolean.

Documents

Returns a Documents collection that represents all the open documents. Read-only.

DontResetInsertionPointProperties

Returns or sets a Boolean that represents whether Microsoft Word maintains the formatting properties of the text at that position of the Insertion Point after running other code. Read/write.

EmailOptions

Returns an EmailOptions object that represents the global preferences for e-mail authoring. Read-only.

EmailTemplate

Returns or sets a String that represents the document template to use when sending e-mail messages. Read/write.

EnableCancelKey

Returns or sets the way that Word handles CTRL+BREAK user interruptions. Read/write WdEnableCancelKey.

FeatureInstall

Returns or sets how Microsoft Word handles calls to methods and properties that require features not yet installed. Read/write MsoReatureInstall.

FileConverters

Returns a FileConverters collection that represents all the file converters available to Microsoft Word. Read-only.

FileDialog

Returns a FileDialog object which represents a single instance of a file dialog box.

FileValidation

Returns or sets how Word will validate files before opening them. Read/write MsoFileValidationMode.

FindKey

Returns a KeyBinding object that represents the specified key combination. Read-only.

FocusInMailHeader

True if the insertion point is in an e-mail header field (the To: field, for example). Read-only Boolean.

FontNames

Returns a FontNames object that includes the names of all the available fonts. Read-only.

HangulHanjaDictionaries

Returns a HangulHanjaConversionDictionaries collection that represents all the active custom conversion dictionaries. .

Height

Returns or sets the height of the active document window. Read/write Long.

International

Returns information about the current country/region and international settings. Read-only Variant.

IsObjectValid

True if the specified variable that references an object is valid. Read-only Boolean.

IsSandboxed

True if the application window is a protected view window. Read-only.

KeyBindings

Returns a KeyBindings collection that represents customized key assignments, which include a key code, a key category, and a command.

KeysBoundTo

Returns a KeysBoundTo object that represents all the key combinations assigned to the specified item.

LandscapeFontNames

Returns a FontNames object that includes the names of all the available landscape fonts.

Language

Returns an MsoLanguageID constant that represents the language selected for the Microsoft Word user interface.

Languages

Returns a Languages collection that represents the proofing languages listed in the Language dialog box (on the Tools menu, click Language, and then click Set Language).

LanguageSettings

Returns a LanguageSettings object, which contains information about the language settings in Microsoft Word.

Left

Returns or sets a Long that represents the horizontal position of the active document, measured in points. Read/write.

ListGalleries

Returns a ListGalleries collection that represents the three list template galleries. .

MacroContainer

Returns a Template or Document object that represents the template or document in which the module that contains the running procedure is stored.

MailingLabel

Returns a MailingLabel object that represents a mailing label.

MailMessage

Returns a MailMessage object that represents the active e-mail message.

MailSystem

Returns the mail system (or systems) installed on the host computer. Read-only WdMailSystem.

MAPIAvailable

True if MAPI is installed. Read-only Boolean.

MathCoprocessorAvailable

True if a math coprocessor is installed and available to Microsoft Word. Read-only Boolean.

MouseAvailable

True if there is a mouse available for the system. Read-only Boolean.

Name

Returns the name of the specified object. Read-only String.

NewDocument

Returns a NewFile object that represents a document listed on the New Document task pane.

NormalTemplate

Returns a Template object that represents the Normal template.

NumLock

Returns the state of the NUM LOCK key. True if the keys on the numeric keypad insert numbers, False if the keys move the insertion point. Read-only Boolean.

OMathAutoCorrect

Returns an OMathAutoCorrect object that represents the auto correct entries for equations. Read-only.

OpenAttachmentsInFullScreen

Returns or sets a Boolean that represents whether Microsoft Word opens e-mail attachments in Reading mode. Read/write.

Options

Returns an Options object that represents application settings in Microsoft Word.

Parent

Returns an Object that represents the parent object of the specified Application object.

Path

Returns the disk or Web path to the specified object. Read-only String.

PathSeparator

Returns the character used to separate folder names. This property returns a backslash (\). Read-only String.

PickerDialog

Returns a PickerDialog object that provides the functionality to select people or data in a dialog box. Read-only.

PortraitFontNames

Returns a FontNames object that includes the names of all the available portrait fonts.

PrintPreview

True if print preview is the current view. Read/write Boolean.

ProtectedViewWindows

Returns a ProtectedViewWindows collection that represents all protected view windows. Read-only.

RecentFiles

Returns a RecentFiles collection that represents the most recently accessed files.

RestrictLinkedStyles

Returns or sets a Boolean that represents whether Microsoft Word allows linked styles. Read/write.

ScreenUpdating

True if screen updating is turned on. Read/write Boolean.

Selection

Returns the Selection object that represents a selected range or the insertion point. Read-only.

ShowStartupDialog

True to display the Task Pane when starting Microsoft Word. Read/write Boolean.

ShowStylePreviews

Returns or sets a Boolean that represents whether Microsoft Word shows a preview of the formatting for styles in the Styles dialog box. Read/write.

ShowVisualBasicEditor

True if the Visual Basic Editor window is visible. Read/write Boolean.

ShowWindowsInTaskbar

True displays opened documents in the task bar, the default Single Document Interface (SDI). False lists opened documents only in the Window menu, providing the appearance of a Multiple Document Interface (MDI). Read/write Boolean.

SmartArtColors

Returns a SmartArtColors object that represents the set of color styles that are currently loaded in the application. Read-only.

SmartArtLayouts

Returns a SmartArtLayouts object that represents the set of SmartArt layouts that are currently loaded in the application. Read-only.

SmartArtQuickStyles

Returns a SmartArtQuickStyles object that represents the set of SmartArt styles that are currently loaded in the application. Read-only.

SpecialMode

True if Microsoft Word is in a special mode (for example, CopyText mode, or MoveText mode). Read-only Boolean.

StartupPath

Returns or sets the complete path of the startup folder, excluding the final separator. Read/write String.

StatusBar

This property is no longer supported in Microsoft Word Visual Basic for Applications.

SynonymInfo

Returns a SynonymInfo object that contains information from the thesaurus on synonyms, antonyms, or related words and expressions for the specified word or phrase.

System

Returns a System object, which can be used to return system-related information and perform system-related tasks.

TaskPanes

Returns a TaskPanes collection that represents the most commonly performed tasks in Microsoft Word.

Tasks

Returns a Tasks collection that represents all the applications that are running.

Templates

Returns a Templates collection that represents all the available templates—global templates and those attached to open documents.

Top

Returns or sets the vertical position of the active document. Read/write Long.

UndoRecord

Returns an UndoRecord object that provides a custom entry point into the undo stack. Read-only.

UsableHeight

Returns the maximum height (in points) to which you can set the height of a Microsoft Word document window. Read-only Long.

UsableWidth

Returns the maximum width (in points) to which you can set the width of a Microsoft Word document window. Read-only Long.

UserAddress

Returns or sets the user's mailing address. Read/write String.

UserControl

True if the document or application was created or opened by the user. Read-only Boolean.

UserInitials

Returns or sets the user's initials, which Microsoft Word uses to construct comment marks. Read/write String.

UserName

Returns or sets the user's name, which is used on envelopes and for the Author document property. Read/write String.

VBE

Returns a VBE object that represents the Visual Basic Editor.

Version

Returns the Microsoft Word version number. Read-only String.

Visible

True if the specified object is visible. Read/write Boolean.

Width

Returns or sets the width of the application window, in points. Read/write Long.

Windows

Returns a Windows collection that represents all document windows. Read-only.

WindowState

Returns or sets the state of the specified document window or task window. Read/write WdWindowState.

WordBasic

Returns an automation object (Word.Basic) that includes methods for all the WordBasic statements and functions available in Word version 6.0 and Word for Windows 95. Read-only.

XMLNamespaces

Returns an XMLNamespaces collection that represents the XML schemas in the Schema Library.

Events

Name

Description

DocumentBeforeClose

Occurs immediately before any open document closes.

DocumentBeforePrint

Occurs before any open document is printed.

DocumentBeforeSave

Occurs before any open document is saved.

DocumentChange

Occurs when a new document is created, when an existing document is opened, or when another document is made the active document.

DocumentOpen

Occurs when a document is opened.

DocumentSync

Occurs when the local copy of a document that is part of a Document Workspace is synchronized with the copy on the server.

EPostageInsert

Occurs when a user inserts electronic postage into a document.

EPostageInsertEx

Occurs when a user inserts electronic postage into a document.

EPostagePropertyDialog

Occurs when a user clicks the E-postage Properties (Labels and Envelopes dialog box) button or Print Electronic Postage toolbar button.

MailMergeAfterMerge

Occurs after all records in a mail merge have merged successfully.

MailMergeAfterRecordMerge

Occurs after each record in the data source successfully merges in a mail merge.

MailMergeBeforeMerge

Occurs when a merge is executed before any records merge.

MailMergeBeforeRecordMerge

Occurs as a merge is executed for the individual records in a merge.

MailMergeDataSourceLoad

Occurs when the data source is loaded for a mail merge.

MailMergeDataSourceValidate

Occurs when a user validates mail merge recipients by clicking Validate in the Mail Merge Recipients dialog box.

MailMergeDataSourceValidate2

Occurs when a user validates mail merge recipients by clicking the Validate addresses link button in the Mail Merge Recipients dialog box.

MailMergeWizardSendToCustom

Occurs when the custom button is clicked during step six of the Mail Merge Wizard.

MailMergeWizardStateChange

Occurs when a user changes from a specified step to a specified step in the Mail Merge Wizard.

NewDocument

Occurs when a new document is created.

ProtectedViewWindowActivate

Occurs when any protected view window is activated.

ProtectedViewWindowBeforeClose

Occurs immediately before a protected view window or a document in a protected view window closes.

ProtectedViewWindowBeforeEdit

Occurs immediately before editing is enabled on the document in the specified protected view window.

ProtectedViewWindowDeactivate

Occurs when a protected view window is deactivated.

ProtectedViewWindowOpen

Occurs when a protected view window is opened.

ProtectedViewWindowSize

The description for this item will appear in a future release.

Quit

Occurs when the user exits Microsoft Word.

WindowActivate

Occurs when any document window is activated.

WindowBeforeDoubleClick

Occurs when the editing area of a document window is double-clicked, before the default double-click action.

WindowBeforeRightClick

Occurs when the editing area of a document window is right-clicked, before the default right-click action.

WindowDeactivate

Occurs when any document window is deactivated.

WindowSelectionChange

Occurs when the selection changes in the active document window.

WindowSize

Occurs when the application window is resized or moved.

XMLSelectionChange

Occurs when the parent XML node of the current selection changes.

XMLValidationError

Occurs when there is a validation error in the document.