This topic has not yet been rated - Rate this topic

DocumentBase Methods

Visual Studio 2012

Visual Studio 2010

The DocumentBase type exposes the following members.

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

Top

Explicit Interface Implementations

	Name	Description
	EntryPoint.BeginInit	Infrastructure.
	EntryPoint.EndInit	Infrastructure.
	EntryPoint.FinishInitialization	Infrastructure.
	EntryPoint.Initialize	Infrastructure.
	EntryPoint.InitializeDataBindings	Infrastructure.
	EntryPoint.OnShutdown	Infrastructure.
	EntryPoint.OnStartup	Infrastructure.
	ICachedDataPersistanceCallback.OnAfterSave
	ICachedDataPersistanceCallback.OnBeforeSave
	IDocumentExtension.CreateRibbonExtensibilityObject	Infrastructure.
	IDocumentExtension.CreateRibbonObjects	Infrastructure.
	IDocumentExtension.GetAutomationObject	Infrastructure.
	IDocumentExtension.ProtectDocument	Infrastructure.
	IDocumentExtension.RequestService	Infrastructure.
	IDocumentExtension.UnprotectDocument	Infrastructure.

Top

Reference

DocumentBase Class

Microsoft.Office.Tools.Word Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)