Xceed Logo
Shop
Xceed Words for .NET v5.1 Documentation
Xceed.Document.NET Assembly / Xceed.Document.NET Namespace / Document Class
Members


In This Topic
    Document Class
    In This Topic
    Represents a document.  
    Syntax
    'Declaration
 
Public Class Document 
   Inherits Container
    'Usage
 
Dim instance As Document
    public class Document : Container
    Inheritance Hierarchy

    System.Object
       Xceed.Document.NET.DocumentElement
          Xceed.Document.NET.Container
             Xceed.Document.NET.Document
                Xceed.Words.NET.DocX

    Public Properties
     NameDescription
    Public PropertyBookmarksGets the collection of Bookmarks in this Document.  
    Public PropertyChartsGets the collection of Charts in this Container. (Inherited from Xceed.Document.NET.Container)
    Public PropertyCheckBoxesGets the collection of CheckBoxes in this Document.  
    Public PropertyCorePropertiesGets the dictionary for the core properties in this Document.  
    Public PropertyCustomPropertiesGets the dictionary for the CustomProperties in this Document.  
    Public PropertyDifferentFirstPageGets or sets if the first page of the first Section in this Document uses an independent Header and Footer.  
    Public PropertyDifferentOddAndEvenPagesGets or sets if the even and odd pages of the Document use different Headers and Footers.  
    Public PropertyEndnoteProperties Gets/sets the properties for endnotes in the first section of the document.  
    Public PropertyEndnotesTextGets the list of end notes in this Document.  
    Public PropertyFootersGets the Footers of the first Section in this Document.  
    Public PropertyFootnotePropertiesGets/sets the properties for footnotes in the first section of the document.  
    Public PropertyFootnotesTextGets the list of foot notes in this Document.  
    Public PropertyHeadersGets the Headers of the first Section in this Document.  
    Public PropertyHyperlinksGets the collection of Hyperlinks in this Container. (Inherited from Xceed.Document.NET.Container)
    Public PropertyHyphenationGets or sets the document hyphenation object.  
    Public PropertyImagesGets the collection of Images in this Document.  
    Public PropertyIsPasswordProtectedGets if this Document is password protected.  
    Public PropertyIsProtectedGets if any editing restrictions are imposed on this Document.  
    Public PropertyListsOverridden. Gets the collection of Lists in this Document.  
    Public PropertyMarginBottomGets or sets the bottom margin (in points) of the first Section in this Document.  
    Public PropertyMarginFooterGets or sets the footer margin (in points) of the first Section in this Document.  
    Public PropertyMarginHeaderGets or sets the header margin (in points) of the first Section in this Document.  
    Public PropertyMarginLeftGets or sets the left margin (in points) of the first Section in this Document.  
    Public PropertyMarginRightGets or sets the right margin (in points) of the first Section in this Document.  
    Public PropertyMarginTopGets or sets the top margin (in points) of the first Section in this Document.  
    Public PropertyMirrorMarginsGets or sets if the mirror margins option is enabled for the first Section in this Document.  
    Public PropertyPackagePartGets or sets the PackagePart for this element. (Inherited from Xceed.Document.NET.DocumentElement)
    Public PropertyPageBackgroundGets or sets the background color to use for all the pages in the document.  
    Public PropertyPageBordersGets or sets the Borders to use for all the pages of the first Section in this Document.  
    Public PropertyPageHeightGets or sets the page height (in points) of the first Section in this Document.  
    Public PropertyPageLayoutGets the PageLayout of the first Section in this Document.  
    Public PropertyPageWidthGets or sets the page width (in points) of the first Section in this Document.  
    Public PropertyParagraphFormattingsReturns a list of all the paragraph formatting styles found inside the document. This list includes all the styled run properties (bold, size, color...) but not the styled paragraph properties (spacing, borders, etc.).  
    Public PropertyParagraphsOverridden. Gets the collection of Paragraphs in this Document.  
    Public PropertyParagraphsDeepSearch (Inherited from Xceed.Document.NET.Container)
    Public PropertyPicturesGets the collection of Pictures in this Container. (Inherited from Xceed.Document.NET.Container)
    Public PropertySectionsOverridden. Gets the cached list of Sections from this Document.  
    Public PropertyShapesGets the collection of Shapes in this Container. (Inherited from Xceed.Document.NET.Container)
    Public PropertySignatureLinesGets the list of all the SignatureLines contained in the document.  
    Public PropertyTablesOverridden. Gets the collection of Tables in this Document.  
    Public PropertyTextGets the text in this Document.   
    Public PropertyTextBoxesGets the collection of TextBoxes in this Container. (Inherited from Xceed.Document.NET.Container)
    Public PropertyWatermarksGets the collection of Watermarks in the Document.  
    Public PropertyXmlGets or sets the XML for this element. (Inherited from Xceed.Document.NET.DocumentElement)
    Top
    Public Methods
     NameDescription
    Public MethodAddChart<T>Used to construct the charts.  
    Public MethodAddCheckBoxAdds a CheckBox to a Document.  
    Public MethodAddCorePropertyAdds a core property to this document. If a core property already exists with the same name, it will be replaced. Core property names are case insensitive.  
    Public MethodAddCustomPropertiesGets the collection of CustomProperty objects & processes them all at once.  
    Public MethodAddCustomPropertyAdds a custom property to the Document.  
    Public MethodAddEndnoteUsed to add a new endnote description in the document.  
    Public MethodAddFootersAdds three new Footers to the first Section of this Document . One for the first page, one for odd pages, and one for even pages.  
    Public MethodAddFootnote Used to add a new footnote description in the document.  
    Public MethodAddHeadersAdds three new Headers to the first Section of this Document . One for the first page, one for odd pages, and one for even pages.  
    Public MethodAddHyperlinkOverloaded. Adds a Hyperlink to a Document's Hyperlink collection.  
    Public MethodAddImageOverloaded. Adds an Image to a Document.  
    Public MethodAddListOverloaded. Adds a List to a Document.  
    Public MethodAddPasswordProtection

    Protects the Document from modifications by adding a protection password.

     
    Public MethodAddProtection

    Protects the document from modifications.

     
    Public MethodAddShapeAdds a Shape to a Document.  
    Public MethodAddTableOverloaded. Adds a Table to a Document.  
    Public MethodAddTextBoxAdds a TextBox to a Document.  
    Public MethodAddWatermarkAdds a Watermark to the Document.  
    Public MethodApplyTemplateOverloaded. Applies a template to the Document.  
    Public MethodClearBookmarksRemoves all the Bookmarks from this Container. (Inherited from Xceed.Document.NET.Container)
    Public MethodCopyMakes a copy of the document.  
    Public MethodDispose

    Releases all resources used by this document.

     
    Public MethodFindAllOverloaded. Retrieves all the indexes in this Container where the provided search value is found. (Inherited from Xceed.Document.NET.Container)
    Public MethodFindUniqueByPatternOverridden.   
    Public MethodGetBookmarksRetrieves the list of Bookmarks found in this Container. (Inherited from Xceed.Document.NET.Container)
    Public MethodGetPageCount

    Gets the number of pages in the document.

     
    Public Methodstatic (Shared in Visual Basic)GetParagraphStyleIdFromStyleNameRetrieves the paragraph's style id from the document, using the provided style name.  
    Public MethodGetProtectionTypeReturns the type of editing protection imposed on this document.  
    Public MethodGetSectionsReads the xml of the Container to create a list of Sections. (Inherited from Xceed.Document.NET.Container)
    Public MethodInsertAtBookmarkOverridden.   
    Public MethodInsertBookmarkInserts a Bookmark to this Container. (Inherited from Xceed.Document.NET.Container)
    Public MethodInsertChart  
    Public MethodInsertChartAfterParagraphInserts a chart in the document after the specified paragraph.  
    Public MethodInsertContentInserts html text (with the html tags) or rtf text (with the rtf tags) in the Document. (Inherited from Xceed.Document.NET.Container)
    Public MethodInsertDefaultTableOfContentsInserts a default Table of Contents in the current document.  
    Public MethodInsertDocumentOverloaded. Inserts the content of a document at a given position inside a base document.  
    Public MethodInsertEquationOverridden.   
    Public MethodInsertListOverloaded. Overridden.   
    Public MethodInsertParagraphOverloaded. Overridden.   
    Public MethodInsertParagraphs

    Inserts many paragraphs in the document using the text parameter. Each '\n' in the text parameter will create a new paragraph.

     
    Public MethodInsertSectionOverloaded. Overridden. Inserts a Section in the Document by making a copy of the previous Section, and optionally track this change.  
    Public MethodInsertSectionPageBreakOverridden. Inserts a Section page break to the Document by making a copy of the previous Section, and optionally track this change.  
    Public MethodInsertTableOverloaded.   
    Public MethodInsertTableOfContentsOverloaded. Inserts a table of contents to the document.  
    Public MethodIsSignatureLineSignedBase method for document to evaluate if a SignatureLine is signed. Returns false by default.  
    Public MethodIsSignatureLineValidBase method for document to evaluate if a SignatureLine is signed and valid. Returns false by default.  
    Public MethodRemoveBookmarkRemoves the specified Bookmark from the Container. (Inherited from Xceed.Document.NET.Container)
    Public Methodstatic (Shared in Visual Basic)RemoveEmptyElements  
    Public MethodRemoveParagraphRemoves a Paragraph from this Container. (Inherited from Xceed.Document.NET.Container)
    Public MethodRemoveParagraphAtRemoves the Paragraph found at a specific location in the Container. (Inherited from Xceed.Document.NET.Container)
    Public MethodRemovePasswordProtectionRemoves the password protection on a Document.  
    Public MethodRemoveProtectionRemoves the protection on a Document.  
    Public MethodRemoveTextRemoves all the Text between a startingTag and an endingTag, even when those tags are located in different Paragraphs.   (Inherited from Xceed.Document.NET.Container)
    Public MethodRemoveTextInGivenFormatRemoves all text occurences that match the provided format. (Inherited from Xceed.Document.NET.Container)
    Public MethodRemoveWatermarkRemoves a Watermark from the Document.  
    Public MethodReplaceAtBookmarkReplaces the text at the specified Bookmark in this Container. (Inherited from Xceed.Document.NET.Container)
    Public MethodReplacePictureTargets a Picture from a specific Paragraph in the Container & replaces it with a new Picture.  (Inherited from Xceed.Document.NET.Container)
    Public MethodReplaceTextOverloaded. Overridden. Replaces all instances of a string with another string.  
    Public MethodReplaceTextWithHTMLOverridden. 

    Replaces all instances of a string with HTML content.

     
    Public MethodReplaceTextWithObjectOverridden. Replaces all instances of a string with an object using the options set via the replaceTextOptions parameter.  
    Public MethodSaveSaves the current Document.  
    Public MethodSaveAsOverloaded. Saves the current Document as a new Document.  
    Public MethodSetDefaultFontSets the default font characteristics of the Document.  
    Public MethodSetDirectionSets the Direction of the content of this Container. (Inherited from Xceed.Document.NET.Container)
    Public MethodUpdateFieldsSets a flag to true, so that when the saved document is opened with MS Word, a popup will appear to ask if the fields should be updated.  
    Public MethodUpdateTrackChangesAuthorChanges the name of the user that is currently modifying the Document.   
    Public MethodValidateBookmarksOverridden.   
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodAddElementInXmlOverridden.   
    Protected MethodclonePackagePart  
    Protected MethodclonePackageRelationship  
    Protected MethodGetMD5HashFromStream  
    Protected Internal MethodInternalCopy  
    Protected Internal MethodSaveHeadersFooters  
    Top
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows 11, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    Document Members
    Xceed.Document.NET Namespace

    Send Feedback