DocumentBase Class

Provides the base class for the ThisDocument class in document-level projects for Microsoft Office Word.

Inheritance Hierarchy

System.Object
Microsoft.Office.Tools.Word.DocumentBase

Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
Public MustInherit Class DocumentBase _
    Implements IDocumentExtension, IExtension, EntryPoint, ISupportInitialize,  _
    IBindableComponent, IComponent, IDisposable, ICachedDataPersistanceCallback
public abstract class DocumentBase : IDocumentExtension, 
    IExtension, EntryPoint, ISupportInitialize, IBindableComponent, IComponent, 
    IDisposable, ICachedDataPersistanceCallback

The DocumentBase type exposes the following members.

Constructors

Name Description
Protected method DocumentBase Infrastructure.

Top

Properties

Name Description
Public property _CodeName Infrastructure.
Public property ActiveTheme Gets the name of the active theme plus the theme formatting options for the document.
Public property ActiveThemeDisplayName Gets the display name of the active theme for the document.
Public property ActiveWindow Gets a Window that represents the active window.
Public property ActiveWritingStyle
Public property Application Gets an Application that represents the creator of the document.
Public property AttachedTemplate Gets or sets a Template that represents the template attached to the document.
Public property AutoFormatOverride Gets or sets a value that indicates whether automatic formatting options override formatting restrictions in a document where formatting restrictions are in effect.
Public property AutoHyphenation Gets or sets a value that indicates whether automatic hyphenation is turned on for the specified document.
Public property Background Gets or sets a Shape that represents the background image for the specified document.
Public property Base Gets the Document object that this DocumentBase object extends.
Public property Bibliography Gets the bibliography references contained within the document.
Public property BindingContext Infrastructure.
Public property Bookmarks Gets a Microsoft.Office.Interop.Word.Bookmarks collection that represents all the bookmarks in the document.
Public property BuiltInDocumentProperties Gets a DocumentProperties collection that represents all the built-in document properties for the document.
Public property Characters Gets a Characters collection that represents the characters in the document.
Public property ChildNodeSuggestions Gets an XMLChildNodeSuggestions collection that represents the list of allowed elements for the DocumentBase (which returns the root elements for all attached schemas) or for the XMLNode object (which returns the child elements of a specified element).
Public property ClickAndTypeParagraphStyle Gets or sets the default paragraph style applied to text by the Click and Type feature in the document.
Public property CoAuthoring Represents co-authoring-related functionality in the document.
Public property CodeName Infrastructure.
Public property CommandBars Gets a CommandBars collection that represents the menu bar and all the toolbars in Microsoft Office Word.
Public property Comments Gets a Comments collection that represents all the comments in the document.
Public property Compatibility Gets a value that indicates whether the specified compatibility option is enabled.
Public property CompatibilityMode Gets a value that specifies the compatibility mode that Word uses when opening the document.
Public property ConsecutiveHyphensLimit Gets or sets the maximum number of consecutive lines that can end with hyphens.
Public property Container Gets the container application for the document.
Public property Content Gets a Range that represents the main document story.
Public property ContentControls Gets the collection of all the content controls in the document.
Public property ContentTypeProperties Gets the metadata that is stored in a document, such as author name, subject, and company.
Public property Controls Gets the collection of managed controls that are contained on the document.
Public property Creator Gets the application in which the document was created.
Public property CurrentRsid Gets a random number that Microsoft Office Word assigns to changes in the document.
Public property CustomDocumentProperties Gets a DocumentProperties collection that represents all the custom document properties for the document.
Public property CustomXMLParts Returns the custom XML parts in the document.
Public property DataBindings Infrastructure.
Public property DataHost Infrastructure.
Public property DefaultTableStyle Gets the table style that is applied to all newly created tables in the document.
Public property DefaultTabStop Gets or sets the interval (in points) between the default tab stops in the document.
Public property DefaultTargetFrame Gets or sets the browser frame in which to display a Web page reached through a hyperlink.
Public property DisableFeatures Gets or sets a value that indicates whether all features introduced after the version specified in the DisableFeaturesIntroducedAfter property are disabled.
Public property DisableFeaturesIntroducedAfter Gets or sets a value that determines whether all features introduced after a specified version of Microsoft Office Word are disabled in the document only.
Public property DocID Infrastructure.
Public property DocumentInspectors Gets a Microsoft.Office.Core.DocumentInspectors object that you can use to locate hidden personal information, such as author name, company name, and revision date.
Public property DocumentLibraryVersions Gets a DocumentLibraryVersions collection that represents the collection of versions of a shared document that has versioning enabled and that is stored in a document library on a server.
Public property DocumentTheme Gets the Microsoft Office theme that is applied to the document.
Public property DoNotEmbedSystemFonts Gets or sets a value that indicates whether Microsoft Office Word embeds common system fonts.
Public property Email Gets an Email object that contains all the e-mail–related properties of the document.
Public property EmbedLinguisticData Gets or sets a value that indicates whether Microsoft Office Word embeds speech and handwriting and controls text service data received from devices connected to Microsoft Office using the Windows Text Service Framework Application Programming Interface.
Public property EmbedSmartTags Gets or sets a value that indicates whether Microsoft Office Word saves the smart tag information in a document. This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010.
.
Public property EmbedTrueTypeFonts Gets or sets a value that indicates whether Microsoft Office Word embeds TrueType fonts in a document when the document is saved.
Public property EncryptionProvider Gets or sets the name of the algorithm encryption provider that Microsoft Office Word uses when encrypting documents.
Public property Endnotes Gets an Endnotes collection that represents all the endnotes in the document.
Public property EnforceStyle Gets or sets a value that indicates whether formatting restrictions are enforced in a protected document.
Public property Envelope Gets an Envelope that represents envelope functionality and the envelope in the document.
Public property FarEastLineBreakLanguage Gets or sets the East Asian language to use when breaking lines of text in the document.
Public property FarEastLineBreakLevel Gets or sets the line break control level for the specified document.
Public property Fields Gets a read-only Fields collection that contains the fields in the main text story.
Public property Final Gets or sets a value that indicates whether the document is final.
Public property Footnotes Gets a Footnotes collection that represents all the footnotes in the document.
Public property FormattingShowClear Gets or sets a value that indicates whether Microsoft Office Word shows Clear Formatting in the Styles and Formatting task pane.
Public property FormattingShowFilter Gets or sets a WdShowFilter constant that represents the styles and formatting displayed in the Styles and Formatting task pane.
Public property FormattingShowFont Gets or sets a value that indicates whether Microsoft Office Word displays font formatting in the Styles and Formatting task pane.
Public property FormattingShowNextLevel Gets or sets a value that indicates whether Microsoft Office Word shows the next heading level when the previous heading level is used.
Public property FormattingShowNumbering Gets or sets a value that indicates whether Microsoft Office Word displays number formatting in the Styles and Formatting task pane.
Public property FormattingShowParagraph Gets or sets a value that indicates whether Microsoft Office Word displays paragraph formatting in the Styles and Formatting task pane.
Public property FormattingShowUserStyleName Gets or sets a value that indicates whether to show user-defined styles.
Public property FormFields Gets a FormFields collection that represents all the form fields in the document.
Public property FormsDesign Gets a value that indicates whether the document is in form design mode.
Public property Frames Gets a Frames collection that represents all the frames in the document.
Public property Frameset Gets a Frameset that represents an entire frames page or a single frame on a frames page.
Public property FullName Gets the name of the document, including the drive or Web path.
Public property GrammarChecked Gets or sets a value that indicates whether a grammar check has been run on the document.
Public property GrammaticalErrors Gets a ProofreadingErrors collection that represents the sentences that failed the grammar check on the document.
Public property GridDistanceHorizontal Gets or sets the amount of horizontal space between the invisible gridlines that Microsoft Office Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.
Public property GridDistanceVertical Gets or sets the amount of vertical space between the invisible gridlines that Microsoft Office Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.
Public property GridOriginFromMargin Gets or sets a value that indicates whether Microsoft Office Word starts the character grid from the upper-left corner of the page.
Public property GridOriginHorizontal Gets or sets the point, relative to the left edge of the page, where you want the invisible grid for drawing, moving, and resizing AutoShapes or East Asian characters to begin in the document.
Public property GridOriginVertical Gets or sets the point, relative to the top of the page, where you want the invisible grid for drawing, moving, and resizing AutoShapes or East Asian characters to begin in the document.
Public property GridSpaceBetweenHorizontalLines Gets or sets the interval at which Microsoft Office Word displays horizontal character gridlines in print layout view.
Public property GridSpaceBetweenVerticalLines Gets or sets the interval at which Microsoft Office Word displays vertical character gridlines in print layout view.
Public property HasMailer Infrastructure.
Public property HasPassword Gets a value that indicates whether a password is required to open the document.
Public property HasRoutingSlip Gets or sets a value that indicates whether the document has a routing slip attached to it.
Public property HasVBProject Gets a value that indicates whether the document has an attached Microsoft Visual Basic for Applications (VBA) project.
Public property HostContext Infrastructure.
Public property HTMLDivisions Gets an HTMLDivisions object that represents an HTML division in a Web document.
Public property HTMLProject Infrastructure.
Public property Hyperlinks Gets a Hyperlinks collection that represents all the hyperlinks in the document.
Public property HyphenateCaps Gets or sets a value that indicates whether words in all capital letters can be hyphenated.
Public property HyphenationZone Gets or sets the width of the hyphenation zone, in points.
Public property Indexes Gets an Indexes collection that represents all the indexes in the document.
Public property InlineShapes Gets an InlineShapes collection that represents all the InlineShape objects in the document.
Public property InnerObject Gets a Microsoft.Office.Interop.Word.Document that represents the underlying native object for the document host item that this DocumentBase represents.
Public property IsMasterDocument Gets a value that indicates whether the document is a master document.
Public property IsSubdocument Gets a value that indicates whether the document is opened in a separate document window as a subdocument of a master document.
Public property ItemProvider Infrastructure.
Public property JustificationMode Gets or sets the character spacing adjustment for the document.
Public property KerningByAlgorithm Gets or sets a value that indicates whether Microsoft Office Word kerns half-width Latin characters and punctuation marks in the document.
Public property Kind Gets or sets the format type that Microsoft Office Word uses when automatically formatting the document.
Public property LanguageDetected Gets or sets a value that indicates whether Microsoft Office Word has detected the language of the text in the document.
Public property ListParagraphs Gets a ListParagraphs collection that represents all the numbered paragraphs in the document.
Public property Lists Gets a Lists collection that contains all the formatted lists in the document.
Public property ListTemplates Gets a ListTemplates collection that represents all the list formats for the document.
Public property LockQuickStyleSet Gets or sets a value that indicates whether users can change the set of Quick Styles that is being used.
Public property LockTheme Gets or sets a value that indicates whether users can change the document theme.
Public property MailEnvelope Gets an MsoEnvelope that represents an e-mail header for a document.
Public property Mailer Infrastructure.
Public property MailMerge Gets a MailMerge that represents the mail merge functionality for the document.
Public property Name Gets the name of the document.
Public property NoLineBreakAfter Gets or sets the kinsoku characters after which Microsoft Office Word will not break a line.
Public property NoLineBreakBefore Gets or sets the kinsoku characters before which Microsoft Office Word will not break a line.
Public property OMathBreakBin Gets or sets a value that specifies where Microsoft Office Word places binary operators when equations span two or more lines.
Public property OMathBreakSub Gets or sets a value that specifies how Microsoft Office Word handles a subtraction operator that falls before a line break.
Public property OMathFontName Gets or sets the name of the font that is used in a document to display equations.
Public property OMathIntSubSupLim Gets or sets a value that specifies the default location of limits for integrals.
Public property OMathJc Gets or sets a value that indicates the default justification—left, right, centered, or centered as a group—of a group of equations.
Public property OMathLeftMargin Gets or sets a value that specifies the left margin for equations.
Public property OMathNarySupSubLim Gets or sets a value that specifies the default location of limits for n-ary objects other than integrals.
Public property OMathRightMargin Gets or sets a value that represents the right margin for equations.
Public property OMaths Gets the collection of OMath objects in the document.
Public property OMathSmallFrac Gets or sets a value that indicates whether to use small fractions in equations contained within the document.
Public property OMathWrap Gets or sets a value that specifies the placement of the second line of an equation that wraps to a new line.
Public property OpenEncoding Gets the encoding used to open the document.
Public property OptimizeForWord97 Gets or sets a value that indicates whether Microsoft Office Word optimizes the document for viewing in Word 97 by disabling any incompatible formatting.
Public property OriginalDocumentTitle Gets the title of the original document after performing a legal-blackline document compare operation.
Public property PageSetup Gets or sets a PageSetup that is associated with the document.
Public property Paragraphs Gets a Paragraphs collection that represents all the paragraphs in the document.
Public property Parent Gets the parent object of the document.
Public property Password Sets a password that must be supplied to open the document.
Public property PasswordEncryptionAlgorithm Gets the algorithm Microsoft Office Word uses for encrypting documents with passwords.
Public property PasswordEncryptionFileProperties Gets a value that indicates whether Microsoft Office Word encrypts file properties for password-protected documents.
Public property PasswordEncryptionKeyLength Gets the key length of the algorithm Microsoft Office Word uses when encrypting documents with passwords.
Public property PasswordEncryptionProvider Gets the name of the algorithm encryption provider that Microsoft Office Word uses when encrypting documents with passwords.
Public property Path Gets the disk or Web path of the document.
Public property Permission Gets a Permission that represents the permission settings for the document.
Public property PrintFormsData Gets or sets a value that indicates whether Microsoft Office Word prints onto a preprinted form only the data entered in the corresponding online form.
Public property PrintFractionalWidths Gets or sets a value that indicates whether the document is formatted to use fractional point spacing to display and print characters.
Public property PrintPostScriptOverText Gets or sets a value that indicates whether PRINT field instructions (such as PostScript commands) in a document are to be printed on top of text and graphics when a PostScript printer is used.
Public property PrintRevisions Gets or sets a value that indicates whether revision marks are printed with the document.
Public property ProtectionType Gets the protection type for the document.
Public property ReadabilityStatistics Gets a ReadabilityStatistics collection that represents the readability statistics for the document.
Public property ReadingLayoutSizeX Gets or sets the width of pages in the document when it is displayed in reading layout view and is frozen for entering handwritten markup.
Public property ReadingLayoutSizeY Gets or sets the height of pages in the document when it is displayed in reading layout view and is frozen for entering handwritten markup.
Public property ReadingModeLayoutFrozen Gets or sets a value that indicates whether pages displayed in reading layout view are frozen to a specified size for inserting handwritten markup into a document.
Public property ReadOnly Gets a value that indicates whether changes to the document cannot be saved to the original document.
Public property ReadOnlyRecommended Gets or sets a value that indicates whether Microsoft Office Word displays a message whenever a user opens the document, suggesting that the document be opened as read-only.
Public property RemoveDateAndTime Gets or sets a value that indicates whether a document stores the date and time metadata for tracked changes.
Public property RemovePersonalInformation Gets or sets a value that indicates whether Microsoft Office Word removes all user information from comments, revisions, and the Properties dialog box when the user saves the document.
Public property Research Gets the research service for the document.
Public property RevisedDocumentTitle Gets the title of the revised document after performing a legal-blackline document compare operation.
Public property Revisions Gets a Revisions collection that represents the tracked changes in the document.
Public property Routed Gets a value that indicates whether the document has been routed to the next recipient.
Public property RoutingSlip Gets a RoutingSlip that represents the routing slip information for the document.
Public property Saved Gets or sets a value that indicates whether the document has not changed since it was last saved.
Public property SaveEncoding Gets or sets the encoding to use when saving the document.
Public property SaveFormat Gets the file format of the document.
Public property SaveFormsData Gets or sets a value that indicates whether Microsoft Office Word saves the data entered in a form as a tab-delimited record for use in a database.
Public property SaveSubsetFonts Gets or sets a value that indicates whether Microsoft Office Word saves a subset of the embedded TrueType fonts with the document.
Public property Scripts Gets a Scripts collection that represents the collection of HTML scripts in the document.
Public property Sections Gets a Sections collection that represents the sections in the document.
Public property Sentences Gets a Sentences collection that represents all the sentences in the document.
Public property ServerPolicy Gets the policy that is specified for the document, when the document is stored on a server that is running Microsoft Office SharePoint Server.
Public property Shapes Gets a Shapes collection that represents all the Shape objects in the document.s
Public property SharedWorkspace Gets a SharedWorkspace that represents the Document Workspace in which the document is located.
Public property ShowGrammaticalErrors Gets or sets a value that indicates whether grammatical errors are marked by a wavy green line in the document.
Public property ShowRevisions Gets or sets a value that indicates whether tracked changes in the document are shown on the screen.
Public property ShowSpellingErrors Gets or sets a value that indicates whether Microsoft Office Word underlines spelling errors in the document.
Public property ShowSummary Gets or sets a value that indicates whether an automatic summary is displayed for the document.
Public property Signatures Gets a SignatureSet that represents the digital signatures for the document.
Public property Site Infrastructure.
Public property SmartDocument Gets a SmartDocument that represents the settings for a smart document solution.
Public property SmartTags Gets a SmartTags object that represents a smart tag in a document. This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010.
.
Public property SmartTagsAsXMLProps Gets or sets a value that indicates whether Microsoft Office Word creates an XML header containing smart tag information when a document containing smart tags is saved as HTML. This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010.
.
Public property SnapToGrid Gets or sets a value that indicates whether AutoShapes or East Asian characters are automatically aligned with an invisible grid when they are drawn, moved, or resized in the document.
Public property SnapToShapes Gets or sets a value that indicates whether Microsoft Office Word automatically aligns AutoShapes or East Asian characters with invisible gridlines that go through the vertical and horizontal edges of other AutoShapes or East Asian characters in the document.
Public property SpellingChecked Gets or sets a value that indicates whether spelling has been checked throughout the document.
Public property SpellingErrors Gets a ProofreadingErrors collection that represents the words identified as spelling errors in the document.
Public property StoryRanges Gets a StoryRanges collection that represents all the stories in the document.
Public property Styles Gets a Styles collection for the document.
Public property StyleSheets Gets a StyleSheets object that represents the Web style sheets attached to the document.
Public property StyleSortMethod Gets or sets a value that specifies the sort method to use when sorting styles in the Styles task pane.
Public property Subdocuments Gets a Subdocuments collection that represents all the subdocuments in the document.
Public property SummaryLength Gets or sets the length of the summary as a percentage of the document length.
Public property SummaryViewMode Gets or sets the way a summary is displayed.
Public property Sync Gets a Sync object that provides access to the methods and properties of documents that are part of a Document Workspace.
Public property Tables Gets a Tables collection that represents all the tables in the document.
Public property TablesOfAuthorities Gets a TablesOfAuthorities collection that represents the tables of authorities in the document.
Public property TablesOfAuthoritiesCategories Gets a TablesOfAuthoritiesCategories collection that represents the available table of authorities categories for the document.
Public property TablesOfContents Gets a TablesOfContents collection that represents the tables of contents in the document.
Public property TablesOfFigures Gets a TablesOfFigures collection that represents the tables of figures in the document.
Public property Tag Gets or sets an object that contains data you want to save with the document.
Public property TextEncoding Gets or sets the code page, or character set, that Microsoft Office Word uses for a document saved as an encoded text file.
Public property TextLineEnding Gets or sets a WdLineEndingType constant indicating how Microsoft Office Word marks the line and paragraph breaks in documents saved as text files.
Public property TrackFormatting Gets or sets a value that indicates whether to track formatting changes when change tracking is turned on.
Public property TrackMoves Gets or sets a value that indicates whether to mark moved text when change tracking is turned on.
Public property TrackRevisions Gets or sets a value that indicates whether changes are tracked in the document.
Public property Type Gets the document type (template or document).
Public property UpdateStylesOnOpen Gets or sets a value that indicates whether the styles in the document are updated to match the styles in the attached template each time the document is opened.
Public property UseMathDefaults Gets or sets a value that indicates whether to use the default math settings when creating new equations.
Public property UserControl Gets or sets a value that indicates whether the document or application was created or opened by the user.
Public property Variables Gets a Variables collection that represents the variables stored in the document.
Public property VBASigned Gets a value that indicates whether the Visual Basic for Applications (VBA) project for the document has been digitally signed.
Public property VBProject Gets the Microsoft.Vbe.Interop.VBProject for the document.
Public property Versions Gets a Versions collection that represents all the versions of the document.
Public property VstoSmartTags Gets the Microsoft.Office.Tools.SmartTagCollection associated with the document.
Public property WebOptions Gets the WebOptions object, which contains document-level attributes used by Microsoft Office Word when you save a document as a Web page or open a Web page.
Public property Windows Gets a Windows collection that represents all windows for the document (for example, Sales.doc:1 and Sales.doc:2).
Public property WordOpenXML Gets an XML string that contains the contents of the document in the Word Open XML format.
Public property Words Gets a Microsoft.Office.Interop.Word.Words collection that represents all the words in the document.
Public property WritePassword Sets a password for saving changes to the document.
Public property WriteReserved Gets a value that indicates whether the document is protected with a write password.
Public property XMLHideNamespaces Gets a value that indicates whether to hide the XML namespaces in the list of elements in the XML Structure task pane.
Public property XMLNodes Gets a Microsoft.Office.Interop.Word.XMLNodes collection that represents the collection of all XML elements within the document.
Public property XMLSaveDataOnly Gets or sets a value that indicates whether Microsoft Office Word saves only the XML data or the entire document.
Public property XMLSaveThroughXSLT Gets or sets the path and file name for the Extensible Stylesheet Language Transformation (XSLT) to apply when a user saves the document.
Public property XMLSchemaReferences Gets an XMLSchemaReferences collection that represents the schemas attached to the document.
Public property XMLSchemaViolations Gets a Microsoft.Office.Interop.Word.XMLNodes collection that represents all nodes in the document that have validation errors.
Public property XMLShowAdvancedErrors Gets or sets a value that indicates whether error message text is generated from the built-in Microsoft Office Word error messages or from the Microsoft XML Core Services (MSXML) 5.0 component included with Office.
Public property XMLUseXSLTWhenSaving Gets or sets a value that indicates whether to save a document through an Extensible Stylesheet Language Transformation (XSLT).

Top

Methods

Name Description
Public method AcceptAllRevisions Accepts all tracked changes in the document.
Public method AcceptAllRevisionsShown Accepts all revisions in the document that are displayed on the screen.
Public method Activate Gives focus to the document.
Public method AddDocumentWorkspaceHeader Infrastructure.
Public method AddMeetingWorkspaceHeader Infrastructure.
Public method AddToFavorites Creates a shortcut to the document and adds it to the Favorites folder.
Public method ApplyDocumentTheme Applies a document theme to a document.
Public method ApplyQuickStyleSet Changes the set of quick styles.
Public method ApplyQuickStyleSet2 Applies the specified quick style set to the document.
Public method ApplyTheme Applies a theme to a document, if the document is open.
Public method AutoFormat Automatically formats the document. Use the Kind property to specify a format type.
Public method AutoSummarize Creates an automatic summary of the document.
Public method BeginInit Infrastructure.
Public method CanCheckin Determines whether Microsoft Office Word can check in the document to a server.
Public method CheckConsistency Searches all text in a Japanese language document and displays instances where character usage is inconsistent for the same words.
Public method CheckGrammar Begins a spelling and grammar check for the document.
Public method CheckIn Puts a document on a server from a local computer, and sets the local document to read-only so that it cannot be edited locally.
Public method CheckInWithVersion Puts a document on a server from a local computer, and sets the local document to read-only so that it cannot be edited locally.
Public method CheckNewSmartTags Accesses the Microsoft Office Web site for available smart tag recognizer and action files. This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010.
.
Public method CheckSpelling Begins a spelling check for the document.
Public method Close Closes the document.
Public method ClosePrintPreview Switches the document from print preview to the previous view. If the document is not in print preview, an exception is thrown.
Public method Compare Displays revision marks that indicate where the document differs from another document.
Public method Compare2000 Infrastructure.
Public method Compare2002 Infrastructure.
Public method ComputeStatistics Gets a statistic based on the contents of the document.
Public method Convert Converts the document to the newest file format and enables all new features.
Public method ConvertAutoHyphens Converts hyphens created by automatic hyphenation to manual hyphens.
Public method ConvertNumbersToText Changes the list numbers and LISTNUM fields in the specified document to text.
Public method ConvertVietDoc Converts a Vietnamese document to Unicode using a code page other than the default.
Public method CopyStylesFromTemplate Copies styles from the specified template to a document.
Public method CountNumberedItems Returns the number of bulleted or numbered items and LISTNUM fields in the document.
Public method CreateLetterContent Creates and returns a LetterContent object based on the specified letter elements.
Protected method CreateRibbonExtensibilityObject Returns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface.
Protected method CreateRibbonObjects Returns an array of OfficeRibbon objects to the CreateRibbonExtensibilityObject method.
Public method DataForm Displays the Data Form dialog box, in which you can add, delete, or modify data records.
Public method DeleteAllComments Deletes all comments from the Comments collection in a document.
Public method DeleteAllCommentsShown Deletes all revisions in the document that are displayed on the screen.
Public method DeleteAllEditableRanges Deletes permissions in all ranges that the specified user or group of users has permission to modify.
Public method DeleteAllInkAnnotations Deletes all handwritten ink annotations in the document.
Public method DetectLanguage Analyzes the text in the document to determine the language that it is written in.
Public method Dispose Infrastructure. Releases the resources used by the DocumentBase.
Public method DowngradeDocument Changes a document to the Word 97-2003 document format so that it can be edited in a previous version of Microsoft Office Word.
Public method EditionOptions Infrastructure.
Public method EndInit Infrastructure.
Public method EndReview Terminates a review of a file that has been sent for review using the SendForReview method or that has been automatically placed in a review cycle by sending a document to another user in an e-mail message.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method ExportAsFixedFormat Saves the document in PDF or XPS format.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method FinishInitialization Infrastructure.
Public method FitToPages Decreases the font size of text just enough so that the document will fit on one fewer pages.
Public method FollowHyperlink Resolves a hyperlink, or displays a cached document if the document has already been downloaded.
Public method ForwardMailer Infrastructure.
Public method FreezeLayout Fixes the layout of the document in Web view as it currently appears so that line breaks remain fixed and ink annotations do not move when you resize the window.
Public method get_ActiveWritingStyle Infrastructure. Use the ActiveWritingStyle property instead of this method.
Public method get_Compatibility Infrastructure. Use the Compatibility property instead of this method.
Protected method GetAutomationObject Called by the Visual Studio Tools for Office runtime to get an object that can be used by VBA code in the document.
Public method GetCrossReferenceItems Gets an array of items that can be cross-referenced based on the specified cross-reference type.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Protected method GetHostItem<T> Infrastructure.
Public method GetLetterContent Retrieves letter elements from the document and returns a LetterContent.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetWorkflowTasks Returns the workflow tasks that are assigned to the document.
Public method GetWorkflowTemplates Returns the workflow templates that are attached to the document.
Public method GoTo Returns a Microsoft.Office.Interop.Word.Range that represents the start position of the specified item, such as a page, bookmark, or field.
Protected method Initialize Infrastructure.
Protected method InitializeDataBindings Infrastructure.
Public method LockServerFile Locks the document on the server, which prevents anyone else from editing it.
Public method MakeCompatibilityDefault Sets the compatibility options on the Compatibility tab in the Options dialog box as the default settings for new documents.
Public method ManualHyphenation Initiates manual hyphenation of a document, one line at a time. The user is prompted to accept or decline suggested hyphenations.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Merge Merges the changes marked with revision marks from one document to another.
Public method Merge2000 Infrastructure.
Protected method OnShutdown Infrastructure.
Protected method OnStartup Infrastructure.
Public method Post Posts the document to a public folder in Microsoft Exchange. This method displays the Send to Exchange Folder dialog box so that a folder can be selected.
Public method PresentIt Opens Microsoft Office PowerPoint with the document loaded.
Public method PrintOut Prints all or part of the document.
Public method PrintOut2000 Infrastructure.
Public method PrintOutOld Infrastructure.
Public method PrintPreview Switches the view to print preview.
Public method Protect Applies one of several types of protection to the document.
Public method Protect2002 Infrastructure.
Protected method ProtectDocument Provides you with an opportunity to reapply password protection to the document after the cached data has been saved.
Public method Range Returns a Microsoft.Office.Interop.Word.Range by using the specified starting and ending character positions.
Public method RecheckSmartTags Removes smart tags recognized by the grammar checker and rechecks the document content against all smart tag recognizers.
Public method Redo Performs the last action that was undone (reverses the Undo method).
Public method RejectAllRevisions Rejects all tracked changes in the document.
Public method RejectAllRevisionsShown Rejects all revisions in the document that are displayed on the screen.
Public method Reload Reloads a cached document by resolving the hyperlink to the document and downloading the document.
Public method ReloadAs Reloads a document based on an HTML document, using the specified document encoding.
Public method RemoveCustomization Removes the customization from the document.
Public method RemoveDocumentInformation Removes metadata, such as properties and comments, from a document.
Public method RemoveDocumentWorkspaceHeader Infrastructure.
Public method RemoveLockedStyles Purges a document of locked styles when formatting restrictions have been applied in a document.
Public method RemoveNumbers Removes numbers or bullets from the document.
Public method RemoveSmartTags Removes all smart tag information from the document. This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010.
.
Public method RemoveTheme Removes the active theme from the document.
Public method Repaginate Repaginates the entire document.
Public method Reply Opens a new e-mail message for replying to the active message. The sender's address is included on the To: line.
Public method ReplyAll Opens a new e-mail message for replying to the active message. The sender’s address and all other recipients' addresses are included on the To: and Cc: lines as appropriate.
Public method ReplyWithChanges Sends an e-mail message to the author of a document that has been sent out for review, notifying him or her that a reviewer has completed review of the document.
Protected method RequestService Returns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface in a document-level customization.
Public method ResetFormFields Clears all form fields in a document, preparing the form to be filled in again.
Public method Route Routes the document, using the document's current routing slip.
Public method RunAutoMacro Runs an auto macro that is stored in the document.
Public method RunLetterWizard Runs the Letter Wizard on the document.
Public method Save Saves the document. If the document has not been saved before, the Save As dialog box prompts the user for a file name.
Public method SaveAs Saves the document with a new name or format. Some of the arguments for this method correspond to the options in the Save As dialog box.
Public method SaveAs2 Saves the document with a new name or format. Some of the arguments for this method correspond to the options in the Save As dialog box.
Public method SaveAs2000 Infrastructure.
Public method SaveAsQuickStyleSet Saves the group of quick styles currently in use.
Public method sblt Infrastructure.
Public method Select Selects the document.
Public method SelectAllEditableRanges Selects all ranges that the specified user or group of users has permission to modify.
Public method SelectContentControlsByTag Returns all the content controls in the document that have the specified tag.
Public method SelectContentControlsByTitle Returns all the content controls in the document that have the specified title.
Public method SelectLinkedControls Returns all the content controls in the document that are linked to the specified custom XML node.
Public method SelectNodes Gets a Microsoft.Office.Interop.Word.XMLNodes collection that represents all the nodes that match the XPath parameter in the order in which they appear in the document.
Public method SelectSingleNode Returns a Microsoft.Office.Interop.Word.XMLNode object that represents the first node in the document that matches the XPath parameter.
Public method SelectUnlinkedControls Returns all the content controls in the document that are not linked to a custom XML part.
Public method SendFax Sends the document as a fax, without any user interaction.
Public method SendFaxOverInternet Sends the document to a fax service provider, who faxes the document to one or more specified recipients.
Public method SendForReview Sends the document in an e-mail message for review by the specified recipients.
Public method SendMail Opens a message window for sending the document through Microsoft Exchange.
Public method SendMailer Infrastructure.
Public method set_ActiveWritingStyle Infrastructure.
Public method set_Compatibility Infrastructure.
Public method SetCompatibilityMode Sets the compatibility mode for the document.
Public method SetDefaultTableStyle Specifies the table style to use for newly created tables in the document.
Public method SetLetterContent
Public method SetPasswordEncryptionOptions Sets the options Microsoft Office Word uses for encrypting documents with passwords.
Public method ToggleFormsDesign Switches form design mode on or off.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TransformDocument Applies the specified Extensible Stylesheet Language Transformation (XSLT) file to the document and replaces the document with the results.
Public method Undo Undoes the last action or a sequence of actions, which are displayed in the Undo list. Returns true if the actions were successfully undone.
Public method UndoClear Clears the list of actions that can be undone for the document. Corresponds to the list of items that appears when you click the arrow beside the Undo button on the Standard toolbar.
Public method UnfreezeLayout Reverses the effect of FreezeLayout, and enables line breaks to change and ink annotations to move when you resize the Web browser window.
Public method Unprotect Removes protection from the document.
Protected method UnprotectDocument Provides you with an opportunity to remove password protection from the document and enable cached data to be saved.
Public method UpdateStyles Copies all styles from the attached template into the document, overwriting any existing styles in the document that have the same name.
Public method UpdateSummaryProperties Updates the keyword and comment text in the Properties dialog box to reflect the AutoSummary content for the document.
Public method ViewCode Displays the code window for the selected ActiveX control in the document.
Public method ViewPropertyBrowser Displays the property window for the selected ActiveX control in the specified document.
Public method WebPagePreview

Top

Events

Name Description
Public event ActivateEvent Occurs when the document becomes the active window.
Public event BeforeClose Occurs immediately before the document closes.
Public event BeforeDoubleClick Occurs when the editing area of the document window is double-clicked, before the default double-click action.
Public event BeforePrint Occurs before the document is printed.
Public event BeforeRightClick Occurs when the editing area of the document window is right-clicked, before the default right-click action.
Public event BeforeSave Occurs before the document is saved.
Public event BindingContextChanged Infrastructure.
Public event BuildingBlockInsert Occurs when a building block is inserted into a document.
Public event CloseEvent Occurs when the document is closed.
Public event ContentControlAfterAdd Occurs after a content control is added to a document.
Public event ContentControlBeforeContentUpdate Occurs just before Microsoft Office Word updates the text in a content control, if the content control is bound to a custom XML part.
Public event ContentControlBeforeDelete Occurs just before a content control is deleted from the document.
Public event ContentControlBeforeStoreUpdate Occurs just before Microsoft Office Word updates data in a custom XML part that is bound to the content control (that is, after the text in the content control changes).
Public event ContentControlOnEnter Occurs when the user clicks in a content control, or when the cursor is moved into a content control programmatically.
Public event ContentControlOnExit Occurs when the user clicks outside a content control, or when the cursor is moved outside a content control programmatically.
Public event Deactivate Occurs when the active document window loses focus.
Public event Disposed Infrastructure.
Public event MailMergeAfterMerge Occurs after all records in a mail merge have merged successfully.
Public event MailMergeAfterRecordMerge Occurs after each record in the data source successfully merges in a mail merge.
Public event MailMergeBeforeMerge Occurs when a merge is executed, before any records merge.
Public event MailMergeBeforeRecordMerge Occurs as a merge is executed for the individual records in a merge.
Public event MailMergeDataSourceLoad Occurs when the data source is loaded for a mail merge.
Public event MailMergeWizardSendToCustom Occurs when the custom button is clicked on step six of the Mail Merge Wizard.
Public event MailMergeWizardStateChange Occurs when a user changes from a specified step to a specified step in the Mail Merge Wizard.
Public event New Occurs when a new document is created.
Public event Open Occurs when the document is opened.
Public event SelectionChange Occurs when the selection changes in the document window.
Public event Shutdown Occurs when the document host item shuts down.
Public event Startup Occurs after the document is running and all the initialization code in the assembly has been run.
Public event SyncEvent Occurs when the local copy of a document that is part of a Document Workspace is synchronized with the copy on the server.
Public event WindowSize Occurs when the document window is resized or moved.
Public event XMLAfterInsert Occurs when a user adds a new XML element to a document. If more than one element is added to the document at the same time (for example, when cutting and pasting XML), the event is raised for each element that is inserted.
Public event XMLBeforeDelete Occurs when a user deletes an XML element from a document. If more than one element is deleted from the document at the same time (for example, when cutting and pasting XML), the event is raised for each element that is deleted.

Top

Explicit Interface Implementations

Name Description
Explicit interface implemetationPrivate method EntryPoint.BeginInit Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.EndInit Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.FinishInitialization Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.Initialize Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.InitializeDataBindings Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.OnShutdown Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.OnStartup Infrastructure.
Explicit interface implemetationPrivate method ICachedDataPersistanceCallback.OnAfterSave
Explicit interface implemetationPrivate method ICachedDataPersistanceCallback.OnBeforeSave
Explicit interface implemetationPrivate method IDocumentExtension.CreateRibbonExtensibilityObject Infrastructure.
Explicit interface implemetationPrivate method IDocumentExtension.CreateRibbonObjects Infrastructure.
Explicit interface implemetationPrivate method IDocumentExtension.GetAutomationObject Infrastructure.
Explicit interface implemetationPrivate method IDocumentExtension.ProtectDocument Infrastructure.
Explicit interface implemetationPrivate method IDocumentExtension.RequestService Infrastructure.
Explicit interface implemetationPrivate method IDocumentExtension.UnprotectDocument Infrastructure.
Explicit interface implemetationPrivate property IExtension.ExtensionBase Infrastructure.

Top

Remarks

The DocumentBase class is the base class for the ThisDocument class in document-level Word projects created by using Visual Studio. Use the ThisDocument class to access the document in your project. For more information, see Programming Document-Level Customizations.

The DocumentBase class provides the same members as a Microsoft.Office.Interop.Word.Document object in the Word primary interop assembly, but it adds the following features:

Creating Document Host Items

You cannot create DocumentBase objects programmatically in Office projects.

In document-level projects, the ThisDocument class (which derives from DocumentBase) is instantiated automatically by the Visual Studio Tools for Office runtime when the end user opens the document. For more information, see Programming Document-Level Customizations.

In application-level projects, you can create Microsoft.Office.Tools.Word.Document host items programmatically by using the GetVstoObject method. For more information, see Extending Word Documents and Excel Workbooks in Application-Level Add-ins at Run Time.

Usage

This type is used only in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. The assembly that defines this type is not part of the Visual Studio Tools for Office runtime. You must deploy this assembly with your solution. For more information, see Assemblies in the Visual Studio Tools for Office Runtime.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Office.Tools.Word Namespace

Other Resources

Host Items and Host Controls Overview

Document Host Item