Aspose.Words Namespace |
The Aspose.Words namespace provides classes for generating, converting, modifying, rendering and printing Microsoft Word documents without utilizing Microsoft Word.
Aspose.Words is written completely in C#, CLS compliant and contains only safe managed code. Microsoft Word is not required in order to use Aspose.Words.
The classes in the Aspose.Words namespace borrow best practices from two well-known frameworks: Microsoft Word Automation and System.Xml. A document in Aspose.Words is represented by a tree of nodes, much like in XML DOM. Where possible, class, method and property names match those found in Microsoft Word Automation.
The main classes in this namespace are:
- Document is the main class of the object model that represents a Microsoft Word document.
- DocumentBuilder provides an easy way to insert content and formatting into a document.
- Node is the base class for all nodes in the document.
- CompositeNode is the base class for all nodes of the document that can contain other nodes, for example Paragraph, Section and Table.
Classes| Class | Description | |
|---|---|---|
  | AbsolutePositionTab |
An absolute position tab is a character which is used to advance the position on
the current line of text when displaying this WordprocessingML content.
|
| Body |
Represents a container for the main text of a section.
|
| Bookmark |
Represents a single bookmark.
|
| BookmarkCollection |
A collection of Bookmark objects that represent the bookmarks in the specified range.
|
| BookmarkEnd |
Represents an end of a bookmark in a Word document.
|
| BookmarkStart |
Represents a start of a bookmark in a Word document.
|
| Border |
Represents a border of an object.
|
| BorderCollection |
A collection of Border objects.
|
| BuildVersionInfo |
Provides information about the current product name and version.
|
| CertificateHolder |
Represents a holder of X509Certificate2 instance.
|
| CleanupOptions |
Allows to specify options for document cleaning.
|
| ComHelper |
Provides methods for COM clients to load a document into Aspose.Words.
|
| Comment |
Represents a container for text of a comment.
|
| CommentCollection |
Provides typed access to a collection of Comment nodes.
|
| CommentRangeEnd |
Denotes the end of a region of text that has a comment associated with it.
|
| CommentRangeStart |
Denotes the start of a region of text that has a comment associated with it.
|
| CompareOptions |
Allows to choose advanced options for document comparison operation.
|
| CompositeNode |
Base class for nodes that can contain other nodes.
|
| ConditionalStyle |
Represents special formatting applied to some area of a table with assigned table style.
|
| ConditionalStyleCollection |
Represents a collection of ConditionalStyle objects.
|
| ControlChar |
Control characters often encountered in documents.
|
| ConvertUtil |
Provides helper functions to convert between various measurement units.
|
| DigitalSignature |
Represents a digital signature on a document and the result of its verification.
|
| DigitalSignatureCollection |
Provides a read-only collection of digital signatures attached to a document.
|
| DigitalSignatureUtil |
Provides methods for signing document.
|
| Document |
Represents a Word document.
|
| DocumentBase |
Provides the abstract base class for a main document and a glossary document of a Word document.
|
| DocumentBuilder |
Provides methods to insert text, images and other content, specify font, paragraph and section formatting.
|
| DocumentReaderPluginLoadException |
Thrown during document load, when the plugin required for reading the document format cannot be loaded.
|
| DocumentVisitor |
Base class for custom document visitors.
|
| EditableRange |
Represents a single editable range.
|
| EditableRangeEnd |
Represents an end of an editable range in a Word document.
|
| EditableRangeStart |
Represents a start of an editable range in a Word document.
|
| EndnoteOptions |
Represents the endnote numbering options for a document or section.
|
| FileCorruptedException |
Thrown during document load, when the document appears to be corrupted and impossible to load.
|
| FileFormatInfo |
Contains data returned by FileFormatUtil document format detection methods.
|
| FileFormatUtil |
Provides utility methods for working with file formats, such as detecting file format
or converting file extensions to/from file format enums.
|
| Font |
Contains font attributes (font name, font size, color, and so on) for an object.
|
| Footnote |
Represents a container for text of a footnote or endnote.
|
| FootnoteOptions |
Represents the footnote numbering options for a document or section.
|
| FrameFormat |
Represents frame related formatting for a paragraph.
|
| HeaderFooter |
Represents a container for the header or footer text of a section.
|
| HeaderFooterCollection |
Provides typed access to HeaderFooter nodes of a Section.
|
| HtmlLoadOptions |
Allows to specify additional options when loading HTML document into a Document object.
|
| Hyphenation |
Provides methods for working with hyphenation dictionaries. These dictionaries prescribe where words of a specific language can be hyphenated.
|
| ImportFormatOptions |
Allows to specify various import options to format output.
|
| IncorrectPasswordException |
Thrown if a document is encrypted with a password and the password specified when opening the document is incorrect or missing.
|
| Inline |
Base class for inline-level nodes that can have character formatting associated with them, but cannot have child nodes of their own.
|
| InlineStory |
Base class for inline-level nodes that can contain paragraphs and tables.
|
| InternableComplexAttr |
Base class for internable complex attribute.
Internable complex attribute should notify parent collection when going to be changed.
|
| InterruptionToken |
This class provides members to manually interrupt Aspose.Words during long running tasks.
|
| LanguagePreferences |
Allows to set up language preferences.
|
| License |
Provides methods to license the component.
|
| ListFormat |
Allows to control what list formatting is applied to a paragraph.
|
| LoadOptions |
Allows to specify additional options (such as password or base URI) when
loading a document into a Document object.
|
| Metered |
Provides methods to set metered key.
|
| Node |
Base class for all nodes of a Word document.
|
| NodeChangingArgs |
Provides data for methods of the INodeChangingCallback interface.
|
| NodeCollection |
Represents a collection of nodes of a specific type.
|
| NodeImporter |
Allows to efficiently perform repeated import of nodes from one document to another.
|
| NodeList |
Represents a collection of nodes matching an XPath query executed using the SelectNodes(String) method.
|
| PageSetup |
Represents the page setup properties of a section.
|
| Paragraph |
Represents a paragraph of text.
|
| ParagraphCollection |
Provides typed access to a collection of Paragraph nodes.
|
| ParagraphFormat |
Represents all the formatting for a paragraph.
|
| PdfLoadOptions |
Allows to specify additional options when loading Pdf document into a Document object.
|
| PlainTextDocument |
Allows to extract plain-text representation of the document's content.
|
| Range |
Represents a contiguous area in a document.
|
| Revision |
Represents a revision (tracked change) in a document node or style.
Use RevisionType to check the type of this revision.
|
| RevisionCollection |
A collection of Revision objects that represent revisions in the document.
|
| RevisionGroup |
Represents a group of sequential Revision objects.
|
| RevisionGroupCollection |
A collection of RevisionGroup objects that represent revision groups in the document.
|
| RtfLoadOptions | |
| Run |
Represents a run of characters with the same font formatting.
|
| RunCollection |
Provides typed access to a collection of Run nodes.
|
| Section |
Represents a single section in a document.
|
| SectionCollection |
A collection of Section objects in the document.
|
| Shading |
Contains shading attributes for an object.
|
| SignatureLineOptions |
Allows to specify options for signature line being inserted. Used in DocumentBuilder.
|
| SignOptions |
Allows to specify options for document signing.
|
| SpecialChar |
Base class for special characters in the document.
|
| Story | |
| Style |
Represents a single built-in or user-defined style.
|
| StyleCollection |
A collection of Style objects that represent both the built-in and user-defined styles in a document.
|
| SubDocument |
Represents a SubDocument - which is a reference to an externally stored document.
|
| TableStyle |
Represents a table style.
|
| TabStop |
Represents a single custom tab stop. The TabStop object is a member of the
TabStopCollection collection.
|
| TabStopCollection |
A collection of TabStop objects that represent custom tabs for a paragraph or a style.
|
| TextColumn |
Represents a single text column. TextColumn is a member of the TextColumnCollection collection.
The TextColumns collection includes all the columns in a section of a document.
|
| TextColumnCollection |
A collection of TextColumn objects that represent all the columns of text in a section of a document.
|
| TxtLoadOptions | |
| UnsupportedFileFormatException |
Thrown during document load, when the document format is not recognized or not supported by Aspose.Words.
|
| VariableCollection |
A collection of document variables.
|
| VbaModule |
Provides access to VBA project module.
|
| VbaModuleCollection |
Represents a collection of VbaModule objects.
|
| VbaProject |
Provides access to VBA project information.
A VBA project inside the document is defined as a collection of VBA modules.
|
| WarningInfo |
Contains information about a warning that Aspose.Words issued during document loading or saving.
|
| WarningInfoCollection |
Represents a typed collection of WarningInfo objects.
|
Interfaces| Interface | Description | |
|---|---|---|
 | IDocumentReaderPlugin |
Defines an interface for external reader plugins that can read a file into a document.
|
| IHyphenationCallback |
Implemented by classes which can register hyphenation dictionaries.
|
| INodeChangingCallback |
Implement this interface if you want to receive notifications when nodes are inserted or removed in the document.
|
| IWarningCallback |
Implement this interface if you want to have your own custom method called to
capture loss of fidelity warnings that can occur during document loading or saving.
|
Enumerations| Enumeration | Description | |
|---|---|---|
 | BorderType |
Specifies sides of a border.
|
| BreakType |
Specifies type of a break inside a document.
|
| CalendarType |
Specifies the type of a calendar.
|
| ComparisonTargetType |
Allows to specify base document which will be used during comparison. Default value is Current.
|
| ConditionalStyleType |
Represents possible table areas to which conditional formatting may be defined in a table style.
|
| ContentDisposition |
Enumerates different ways of presenting the document at the client browser.
|
| DigitalSignatureType |
Specifies the type of a digital signature.
|
| DocumentDirection |
Allows to specify the direction to flow the text in a document.
|
| DropCapPosition |
Specifies the position for a drop cap text.
|
| EditingLanguage |
Specifies the editing language.
|
| EditorType |
Specifies the set of possible aliases (or editing groups) which can be used as aliases to
determine if the current user shall be allowed to edit a single range
defined by an editable range within a document.
|
| EndnotePosition |
Defines the endnote position.
|
| FindReplaceDirection |
Specifies direction for replace operations.
|
| FootnoteNumberingRule |
Determines when automatic footnote or endnote numbering restarts.
|
| FootnotePosition |
Defines the footnote position.
|
| FootnoteType |
Specifies whether this is a footnote or an endnote.
|
| HeaderFooterType |
Identifies the type of header or footer found in a Word file.
|
| HeightRule |
Specifies the rule for determining the height of an object.
|
| HtmlControlType |
Type of document nodes that represent <input> and <select> elements imported from HTML.
|
| ImportFormatMode |
Specifies how formatting is merged when importing content from another document.
|
| LineNumberRestartMode |
Determines when automatic line numbering restarts.
|
| LineSpacingRule |
Specifies line spacing values for a paragraph.
|
| LineStyle |
Specifies line style of a Border.
|
| LoadFormat |
Indicates the format of the document that is to be loaded.
|
| NodeChangingAction |
Specifies the type of node change.
|
| NodeType |
Specifies the type of a Word document node.
|
| NumberStyle |
Specifies the number style for a list, footnotes and endnotes, page numbers.
|
| Orientation |
Specifies page orientation.
|
| OutlineLevel |
Specifies the outline level of a paragraph in the document.
|
| PageBorderAppliesTo |
Specifies which pages the page border is printed on.
|
| PageBorderDistanceFrom |
Specifies the positioning of the page border relative to the page margin.
|
| PageVerticalAlignment |
Specifies vertical justification of text on each page.
|
| PaperSize |
Specifies paper size.
|
| ParagraphAlignment |
Specifies text alignment in a paragraph.
|
| ProtectionType |
Protection type for a document.
|
| RevisionsView |
Allows to specify whether to work with the original or revised version of a document.
|
| RevisionType |
Specifies the type of change being tracked in Revision.
|
| SaveFormat |
Indicates the format in which the document is saved.
|
| SectionLayoutMode |
Specifies the layout mode for a section allowing to define the document grid behavior.
|
| SectionStart |
The type of break at the beginning of the section.
|
| StoryType |
Text of a Word document is stored in stories. StoryType identifies a story.
|
| StyleIdentifier |
Locale independent style identifier.
|
| StyleType |
Represents type of the style.
|
| TabAlignment |
Specifies the alignment/type of a tab stop.
|
| TabLeader |
Specifies the type of the leader line displayed under the tab character.
|
| TextDmlEffect |
Dml text effect for text runs.
|
| TextEffect |
Animation effect for text runs.
|
| TextOrientation |
Specifies orientation of text on a page, in a table cell or a text frame.
|
| TextureIndex |
Specifies shading texture.
|
| TxtLeadingSpacesOptions |
Specifies available options for leading space handling during import from Text file.
|
| TxtTrailingSpacesOptions |
Specifies available options for trailing spaces handling during import from Text file.
|
| Underline |
Indicates type of the underline applied to a font.
|
| VbaModuleType |
Specifies the type of a model in a VBA project.
|
| VisitorAction |
Allows the visitor to control the enumeration of nodes.
|
| WarningSource |
Specifies the module that produces a warning during document loading or saving.
|
| WarningType |
Specifies the type of a warning that is issued by Aspose.Words during document loading or saving.
|