Bookmark Interface

The Bookmark control is a bookmark that has a unique name, exposes events, and can be bound to data.

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

[GuidAttribute("716bd356-0f64-430b-9ea0-bde2921a0227")]
public interface Bookmark : IBindableComponent, 
	IComponent, IDisposable, ISupportInitialize

The Bookmark type exposes the following members.

  NameDescription
Public propertyApplicationGets an Application that represents the creator of the Bookmark control.
Public propertyBindingContextGets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public propertyBoldGets or sets a value that indicates whether the text in the Bookmark control is formatted as bold.
Public propertyBoldBiGets or sets a value that indicates whether the text in the Bookmark control is formatted as bold.
Public propertyBookmarkIDGets the position of the Bookmark control in the document.
Public propertyBookmarksGets a Microsoft.Office.Interop.Word.Bookmarks collection that represents all the bookmarks inside of the Bookmark control.
Public propertyBordersGets a Borders collection that represents all the borders for the Bookmark control.
Public propertyCanEditInfrastructure.
Public propertyCanPasteInfrastructure.
Public propertyCaseGets or sets a WdCharacterCase constant that represents the case of the text in the Bookmark control.
Public propertyCellsGets a Cells collection that represents the table cells in a Bookmark control.
Public propertyCharactersGets a Characters collection that represents the characters in a Bookmark control.
Public propertyCharacterStyleGets the style that is used to format one or more characters in the Bookmark.
Public propertyCharacterWidthGets or sets the character width of the text in the Bookmark control.
Public propertyColumnGets a value that indicates whether the Bookmark control is a table column.
Public propertyColumnsGets a Columns collection that represents all the table columns in the Bookmark control.
Public propertyCombineCharactersGets or sets a value that indicates whether the Bookmark control contains combined characters.
Public propertyCommentsGets a Comments collection that represents all the comments in the Bookmark control.
Public propertyConflictsGets all the co-authoring conflicts in the Bookmark.
Public propertyContainerInfrastructure.
Public propertyContentControlsGets the content controls that are contained in the Bookmark.
Public propertyCreatorGets a value that indicates the application in which the Bookmark control was created.
Public propertyDataBindingsGets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public propertyDefaultDataSourceUpdateModeGets or sets the default DataSourceUpdateMode for the Bookmark.
Public propertyDisableCharacterSpaceGridGets or sets a value that indicates whether Microsoft Office Word ignores the number of characters per line for the corresponding Bookmark control.
Public propertyDocumentGets the Microsoft.Office.Interop.Word.Document associated with the Bookmark control.
Public propertyDuplicateGets a read-only Range object that represents all the properties of the Bookmark control.
Public propertyEditorsGets an Editors object that represents all the users authorized to modify a Bookmark control within a document.
Public propertyEmphasisMarkGets or sets the emphasis mark for a character or designated character string within a Bookmark control.
Public propertyEmptyGets a value that indicates whether the Bookmark control is empty.
Public propertyEndGets or sets the ending character position of a Bookmark control.
Public propertyEndnoteOptionsGets an EndnoteOptions object that represents the endnotes in Bookmark control.
Public propertyEndnotesGets an Endnotes collection that represents all the endnotes in a Bookmark control.
Public propertyEnhMetaFileBitsGets a picture representation of how the range of the Bookmark control appears.
Public propertyFieldsGets a read-only Fields collection that represents all the fields in the Bookmark control.
Public propertyFindGets a Find object that contains the criteria for a find operation within a Bookmark control.
Public propertyFitTextWidthGets or sets the width (in the current measurement units) in which Microsoft Office Word fits the text in the Bookmark control.
Public propertyFontGets or sets a Font object that represents the character formatting of the text assigned to a Bookmark control.
Public propertyFootnoteOptionsGets a FootnoteOptions object that represents the footnotes in a Bookmark control.
Public propertyFootnotesGets a Footnotes collection that represents all the footnotes in a Bookmark control.
Public propertyFormattedTextGets or sets a Range object that includes the formatted text in the Bookmark control.
Public propertyFormFieldsGets a FormFields collection that represents all the form fields in the Bookmark control.
Public propertyFramesGets a Frames collection that represents all the frames in a Bookmark control.
Public propertyGrammarCheckedGets or sets a value that indicates whether a grammar check has been run on the Bookmark control.
Public propertyGrammaticalErrorsGets a ProofreadingErrors collection that represents the sentences that failed the grammar check on the Bookmark control.
Public propertyHighlightColorIndexGets or sets the highlight color for the Bookmark control.
Public propertyHorizontalInVerticalGets or sets the formatting for horizontal text set within vertical text in the Bookmark control.
Public propertyHTMLDivisionsGets an HTMLDivisions object that represents an HTML division in a Web document.
Public propertyHyperlinksGets a Hyperlinks collection that represents all the hyperlinks in the Bookmark control.
Public propertyIDGets or sets the identifying label for the Bookmark control when the current document is saved as a Web page.
Public propertyInformationGets information about the Bookmark control.
Public propertyInlineShapesGets an InlineShapes collection that represents all the InlineShape objects in a Bookmark control.
Public propertyInnerObjectGets the underlying Microsoft.Office.Interop.Word.Bookmark object of the Microsoft.Office.Tools.Word.Bookmark control.
Public propertyIsEndOfRowMarkGets a value that indicates whether the Bookmark control is collapsed and is located at the end-of-row mark in a table.
Public propertyItalicGets or sets a value indicating whether the text in a Bookmark control is formatted as italic.
Public propertyItalicBiGets or sets a value that indicates whether the text in the Bookmark control is formatted as italic.
Public propertyKanaGets or sets a value that indicates whether the specified range of Japanese language text in a Bookmark control is hiragana or katakana.
Public propertyLanguageDetectedGets or sets a value that indicates whether Microsoft Office Word has detected the language of the text in the Bookmark control.
Public propertyLanguageIDGets or sets the language for the Bookmark control.
Public propertyLanguageIDFarEastGets or sets an East Asian language for the Bookmark control.
Public propertyLanguageIDOtherGets or sets the language for the Bookmark control.
Public propertyListFormatGets a ListFormat object that represents all the list formatting characteristics of a Bookmark control.
Public propertyListParagraphsGets a ListParagraphs collection that represents all the numbered paragraphs in the Bookmark control.
Public propertyListStyleGets the style that is used to format a bulleted list or numbered list in the Bookmark.
Public propertyLocksGets the co-authoring locks in the Bookmark.
Public propertyNameGets the name of the Bookmark control.
Public propertyNextStoryRangeGets a Range object that refers to the next story, as shown in the following table.
Public propertyNoProofingGets or set a value that indicates whether the spelling and grammar checker ignores the text in the Bookmark control.
Public propertyOMathsGets the equations that are contained in the Bookmark.
Public propertyOrientationGets or sets the orientation of text in a Bookmark control when the Text Direction feature is enabled.
Public propertyPageSetupGets or sets the Microsoft.Office.Interop.Word.PageSetup that is associated with the range of the Bookmark control.
Public propertyParagraphFormatGets or sets a Microsoft.Office.Interop.Word.ParagraphFormat object that represents the paragraph settings for the Bookmark control.
Public propertyParagraphsGets a Microsoft.Office.Interop.Word.Paragraphs collection that represents all the paragraphs in the Bookmark control.
Public propertyParagraphStyleGets the style that is used to format paragraphs in the Bookmark.
Public propertyParentGets the parent object of the Bookmark control.
Public propertyParentContentControlGets the parent content control for the Bookmark.
Public propertyPreviousBookmarkIDGets a value that represents the number of the last bookmark that starts before or at the same place as the Bookmark control.
Public propertyRangeGets a Range object that represents the portion of a document that is contained in the Bookmark control.
Public propertyReadabilityStatisticsGets a ReadabilityStatistics collection that represents the readability statistics for the Bookmark control.
Public propertyRevisionsGets a Revisions collection that represents the tracked changes in the Bookmark control.
Public propertyRowsGets a Rows collection that represents all the table rows in a Bookmark control.
Public propertyScriptsGets a Scripts collection that represents the collection of HTML scripts in the Bookmark control.
Public propertySectionsGets a Sections collection that represents the sections in the Bookmark control.
Public propertySentencesGets a Sentences collection that represents all the sentences in the Bookmark control.
Public propertyShadingGets a Shading object that refers to the shading formatting for the Bookmark control.
Public propertyShapeRangeGets a ShapeRange collection that represents all the Shape objects in the Bookmark control.
Public propertyShowAllGets or sets a value that indicates whether all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) within a Bookmark control are displayed.
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public propertySmartTagsGets a SmartTags object that represents a smart tag in a Bookmark control. 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 propertySpellingCheckedGets or sets a value that indicates whether spelling has been checked throughout the Bookmark control.
Public propertySpellingErrorsGets a ProofreadingErrors collection that represents the words identified as spelling errors in the Bookmark control.
Public propertyStartGets or sets the starting character position of a Bookmark control.
Public propertyStoryLengthGets the number of characters in the story that contains the Bookmark control.
Public propertyStoryTypeGets the story type for the Bookmark control.
Public propertyStyleGets or sets the style for the Bookmark control.
Public propertySynonymInfoGets a SynonymInfo that contains information from the thesaurus on synonyms, antonyms, or related words and expressions for the text in the Bookmark control.
Public propertyTablesGets a Tables collection that represents all the tables in the Bookmark control.
Public propertyTableStyleGets the style that is used to format tables in the Bookmark.
Public propertyTagInfrastructure.
Public propertyTextGets or sets the text in the Bookmark control.
Public propertyTextRetrievalModeGets or sets a TextRetrievalMode object that controls how text is retrieved from the Bookmark control.
Public propertyTopLevelTablesGets a Tables collection that represents the tables at the outermost nesting level in the range of the Bookmark control.
Public propertyTwoLinesInOneGets or sets a value that indicates whether Microsoft Office Word sets two lines of text in one and specifies the characters, if any, that enclose the text in a Bookmark control.
Public propertyUnderlineGets or sets the type of underline applied to the text of the Bookmark control.
Public propertyUpdatesGets all the available co-authoring updates in the Bookmark.
Public propertyWordOpenXMLGets the contents of the Bookmark in the Word Open XML format.
Public propertyWordsGets a Words collection that represents all the words in a Bookmark control.
Public propertyXMLGets the XML text in the Bookmark control.
Public propertyXMLNodesGets an XMLNodes collection that represents the collection of all XML elements within a Bookmark control, including those elements that are only partially within the Bookmark control.
Public propertyXMLParentNodeGets an Microsoft.Office.Interop.Word.XMLNode object that represents the parent node of a Bookmark control.
Top

  NameDescription
Public methodAutoFormatAutomatically formats a Bookmark control.
Public methodBeginInitSignals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public methodCalculateCalculates a mathematical expression within a Bookmark control.
Public methodCheckGrammarBegins a spelling and grammar check for the Bookmark control.
Public methodCheckSpellingBegins a spelling check for the document from the start of the Bookmark control to the end of the document.
Public methodCheckSynonymsDisplays the Thesaurus dialog box, which lists alternative word choices, or synonyms, for the text in the Bookmark control.
Public methodCollapseCollapses a Bookmark control to the starting or ending position.
Public methodComputeStatisticsGets a statistic based on the contents of the Bookmark control.
Public methodConvertHangulAndHanjaConverts the Bookmark control text from Hangul to Hanja or vice versa.
Public methodConvertToTableConverts text within a Bookmark control to a table.
Public methodConvertToTableOldInfrastructure.
Public methodCopy()Creates a new Microsoft.Office.Interop.Word.Bookmark in the same location as the existing Microsoft.Office.Tools.Word.Bookmark control.
Public methodCopy(String)Creates a new Microsoft.Office.Interop.Word.Bookmark with the specified Name argument in the same location as the existing Microsoft.Office.Tools.Word.Bookmark control.
Public methodCopyAsPictureThe CopyAsPicture method copies the contents of the Bookmark control to the Clipboard.
Public methodCreatePublisherInfrastructure.
Public methodCutRemoves the contents of the Bookmark control from the document and places it in the Clipboard.
Public methodDeleteDeletes a dynamically created Bookmark from the document and removes it from the ControlCollection.
Public methodDetectLanguageAnalyzes the text of the Bookmark control to determine the language that it is written in.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodEndInitSignals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public methodEndOfMoves or extends the ending character position of a Bookmark control to the end of the nearest text unit.
Public methodExpandExpands the Bookmark control.
Public methodExportAsFixedFormatSaves the Bookmark in PDF or XPS format.
Public methodExportFragmentExports the Bookmark to a document for use as a document fragment.
Public methodget_InformationInfrastructure. Use the Information property instead of this method.
Public methodget_XMLInfrastructure. Use the XML property instead of this method.
Public methodGetSpellingSuggestionsGets a SpellingSuggestions collection that represents the words suggested as spelling replacements for the first word in the Bookmark control.
Public methodGoToGets a Range object that represents the start position of an item within the Bookmark control.
Public methodGoToEditableRangeGets a Range object that represents an area of a Bookmark control that can be modified by the user or group of users.
Public methodGoToNextGets a Range object that refers to the start position of the next item or location within the Bookmark control specified by the What argument.
Public methodGoToPreviousGets a Range object that refers to the start position of the previous item or location in the Bookmark control specified by the What argument.
Public methodImportFragmentImports a document fragment into the Bookmark.
Public methodInRangeDetermines if the Range to which the method is applied is contained in the Bookmark control.
Public methodInsertAfterInserts the specified text at the end of a Bookmark control.
Public methodInsertAlignmentTabInserts an absolute tab in the Bookmark that is always positioned in the same spot, relative to either the margins or indents.
Public methodInsertAutoTextAttempts to match the text in the Bookmark control with an existing AutoText entry name.
Public methodInsertBeforeInserts the specified text before the Bookmark control.
Public methodInsertBreakInserts a page, column, or section break into the Bookmark control.
Public methodInsertCaptionInserts a caption immediately preceding or following the Bookmark control.
Public methodInsertCaptionXPInfrastructure.
Public methodInsertCrossReferenceInserts a cross-reference to a heading, bookmark, footnote, or endnote, or to an item for which a caption label is defined (for example, an equation, figure, or table) into a Bookmark control.
Public methodInsertCrossReference_2002Infrastructure.
Public methodInsertDatabaseRetrieves data from a data source (for example, a separate Microsoft Office Word document, a Microsoft Office Excel worksheet, or a Microsoft Access database) and inserts the data as a table in place of the Bookmark control.
Public methodInsertDateTimeInserts the current date or time, or both, either as text or as a TIME field in the Bookmark control.
Public methodInsertDateTimeOldInfrastructure.
Public methodInsertFileInserts all or part of the specified file into the Bookmark control.
Public methodInsertParagraphReplaces the Bookmark control with a new paragraph.
Public methodInsertParagraphAfterInserts a paragraph mark after a Bookmark control.
Public methodInsertParagraphBeforeInserts a new paragraph before the Bookmark control.
Public methodInsertSymbolInserts a symbol in place of the Bookmark control.
Public methodInsertXMLInserts the specified XML text into the Bookmark control.
Public methodInStoryDetermines if the Bookmark control to which this method is applied is in the same story as the range specified by the Range argument.
Public methodIsEqualDetermines if the Bookmark control to which this method is applied is equal to the range specified by the Range argument.
Public methodLookupNamePropertiesLooks up a name in the global address book list and displays the Properties dialog box, which includes information about the specified name of the Bookmark control.
Public methodModifyEnclosureAdds, modifies, or removes an enclosure around the specified character or characters in the Bookmark control.
Public methodMoveInfrastructure.
Public methodMoveEndMoves the ending character position of a Bookmark control.
Public methodMoveEndUntilMoves the end position of the Bookmark control until any of the specified characters are found in the document.
Public methodMoveEndWhileMoves the ending character position of a Bookmark control while any of the specified characters are found in the document.
Public methodMoveStartMoves the start position of the Bookmark control.
Public methodMoveStartUntilMoves the start position of the Bookmark control until one of the specified characters is found in the document.
Public methodMoveStartWhileMoves the start position of the Bookmark control while any of the specified characters are found in the document.
Public methodMoveUntilMoves the Bookmark control until one of the specified characters is found in the document.
Public methodMoveWhileMoves the Bookmark control while any of the specified characters are found in the document.
Public methodNextGets a Range object that represents the specified unit relative to the Bookmark control.
Public methodPasteInserts the contents of the Clipboard into the Bookmark control.
Public methodPasteAndFormatPastes the selected table cells into the Bookmark control and formats them as specified.
Public methodPasteAppendTableMerges pasted cells into an existing table in a Bookmark control by inserting the pasted rows between the selected rows.
Public methodPasteAsNestedTablePastes a cell or group of cells as a nested table into the Bookmark control.
Public methodPasteExcelTablePastes and formats a Microsoft Office Excel table into the Bookmark control.
Public methodPasteSpecialInserts the contents of the Clipboard into the Bookmark control.
Public methodPhoneticGuideAdds phonetic guides to the Bookmark control.
Public methodPreviousGets a Range object relative to the Bookmark control.
Public methodRelocateIn outline view, moves the paragraphs within the Bookmark control after the next visible paragraph or before the previous visible paragraph.
Public methodSelectSelects the Bookmark control.
Public methodSetListLevelSets the list level for one or more items in a numbered list in the Bookmark.
Public methodSetRangeSets the starting and ending character positions for the Bookmark control.
Public methodSortSorts the paragraphs in the Bookmark control.
Public methodSortAscendingSorts paragraphs or table rows in ascending alphanumeric order within a Bookmark control.
Public methodSortDescendingSorts paragraphs or table rows in descending alphanumeric order within a Bookmark control.
Public methodSortOldInfrastructure.
Public methodStartOfMoves or extends the start position of the Bookmark control to the beginning of the nearest specified text unit.
Public methodSubscribeToInfrastructure.
Public methodTCSCConverterConverts the specified range of a Bookmark control from Traditional Chinese to Simplified Chinese or vice versa.
Public methodWholeStoryExpands a Bookmark control to include the entire story.
Top

  NameDescription
Public eventBeforeDoubleClickOccurs when a Bookmark control is double-clicked, before the default double-click action.
Public eventBeforeRightClickOccurs when a Bookmark control is right-clicked, before the default right-click action.
Public eventBindingContextChangedOccurs when the value of the BindingContext property of the Bookmark changes.
Public eventDeselectedOccurs when selection moves from the Bookmark control to an area outside of the Bookmark control.
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public eventSelectedOccurs when the Bookmark control is selected.
Public eventSelectionChangeOccurs when the selection inside the Bookmark control changes.
Top

Use the AddBookmark method to add a bookmark to a document range.

NoteNote

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft