Package com.aspose.words

The com.aspose.words package provides classes for generating, converting and modifying Microsoft Word documents without utilizing Microsoft Word.

Aspose.Words is written completely in Java. Microsoft Word is not required in order to use Aspose.Words.

The classes in the com.aspose.words package 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:

The com.aspose.words package also contains classes that form the reporting engine of Aspose.Words. The reporting engine allows to quickly and easily populate documents designed in Microsoft Word with data from various data sources such as java.sql.ResultSet, array of ResultSets, com.aspose.words.net.System.Data.DataSet or an array of values.

The MailMerge object which provides access to the reporting functionality is available via the Document.MailMerge property.

Class Summary
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.
BuildingBlock Represents a glossary document entry such as a Building Block, AutoText or an AutoCorrect entry.
BuildingBlockCollection A collection of BuildingBlock objects in the document.
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.
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.
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.
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.
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.
Fill Defines a fill for a shape.
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.
GlossaryDocument Represents the root element for a glossary document within a Word document. A glossary document is a storage for AutoText, AutoCorrect entries and Building Blocks.
GroupShape Represents a group of shapes in a document.
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.
ImageData Defines an image for a shape.
ImageSize Contains information about image size and resolution.
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.
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 CompositeNode.selectNodes(java.lang.String) method.
OleFormat Provides access to the data of an OLE object or ActiveX control.
OlePackage Allows to access OLE Package properties.
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.
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.
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.
Shape Represents an object in the drawing layer, such as an AutoShape, textbox, freeform, OLE object, ActiveX control, or picture.
ShapeBase Base class for objects in the drawing layer, such as an AutoShape, freeform, OLE object, ActiveX control, or picture.
SignatureLine Provides access to signature line properties.
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 Base class for elements that contain block-level nodes Paragraph and Aspose.Words.Tables.Table.
Stroke Defines a stroke for a shape.
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.
TextBox Defines attributes that specify how a text is displayed inside a shape.
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.
TextPath Defines the text and formatting of the text path (of a WordArt object).
VariableCollection A collection of document variables.
WarningInfo Contains information about a warning that Aspose.Words issued during document loading or saving.
WarningInfoCollection Represents a typed collection of WarningInfo objects.
 

Interface Summary
IHyphenationCallback Implemented by classes which can register hyphenation dictionaries. Use this mehod
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.
 

Exception Summary
FileCorruptedException Thrown during document load, when the document appears to be corrupted and impossible to load.
IncorrectPasswordException Thrown if a document is encrypted with a password and the password specified when opening the document is incorrect or missing.
UnsupportedFileFormatException Thrown during document load, when the document format is not recognized or not supported by Aspose.Words.
 

Constant Summary
ArrowLength Utility class containing constants. Length of the arrow at the end of a line.
ArrowType Utility class containing constants. Specifies the type of an arrow at a line end.
ArrowWidth Utility class containing constants. Width of the arrow at the end of a line.
BorderType Utility class containing constants. Specifies sides of a border.
BreakType Utility class containing constants. Specifies type of a break inside a document.
BuildingBlockBehavior Utility class containing constants. Specifies the behavior that shall be applied to the contents of the building block when it is inserted into the main document.
BuildingBlockGallery Utility class containing constants. Specifies the predefined gallery into which a building block is classified.
BuildingBlockType Utility class containing constants. Specifies a building block type. The type might affect the visibility and behavior of the building block in Microsoft Word.
CalendarType Utility class containing constants. Specifies the type of a calendar.
ComparisonTargetType Utility class containing constants. Allows to specify base document which will be used during comparison. Default value is CURRENT.
ContentDisposition Utility class containing constants. Enumerates different ways of presenting the document at the client browser.
ControlChar Utility class containing constants. Control characters often encountered in documents.
DashStyle Utility class containing constants. Dashed line style.
DigitalSignatureType Utility class containing constants. Specifies the type of a digital signature.
DropCapPosition Utility class containing constants. Specifies the position for a drop cap text.
EditorType Utility class containing constants. 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.
EndCap Utility class containing constants. Specifies line cap style.
EndnotePosition Utility class containing constants. Defines the endnote position.
FindReplaceDirection Utility class containing constants. Specifies direction for replace operations.
FlipOrientation Utility class containing constants. Possible values for the orientation of a shape.
FootnoteLocation Utility class containing constants. Defines the footnote or endnote position.
FootnoteNumberingRule Utility class containing constants. Determines when automatic footnote or endnote numbering restarts.
FootnotePosition Utility class containing constants. Defines the footnote position.
FootnoteType Utility class containing constants. Specifies whether this is a footnote or an endnote.
HeaderFooterType Utility class containing constants. Identifies the type of header or footer found in a Word file.
HeightRule Utility class containing constants. Specifies the rule for determining the height of an object.
HorizontalAlignment Utility class containing constants. Specifies horizontal alignment of a floating shape, text frame or floating table.
HtmlControlType Utility class containing constants. Type of document nodes that represent <input> and <select> elements imported from HTML.
ImageType Utility class containing constants. Specifies the type (format) of an image in a Microsoft Word document.
ImportFormatMode Utility class containing constants. Specifies how formatting is merged when importing content from another document.
JoinStyle Utility class containing constants. Line join style.
LayoutFlow Utility class containing constants. Determines the flow of the text layout in a textbox.
LineNumberRestartMode Utility class containing constants. Determines when automatic line numbering restarts.
LineSpacingRule Utility class containing constants. Specifies line spacing values for a paragraph.
LineStyle Utility class containing constants. Specifies line style of a Border.
LoadFormat Utility class containing constants. Indicates the format of the document that is to be loaded.
NodeChangingAction Utility class containing constants. Specifies the type of node change.
NodeType Utility class containing constants. Specifies the type of a Word document node.
NumberStyle Utility class containing constants. Specifies the number style for a list, footnotes and endnotes, page numbers.
Orientation Utility class containing constants. Specifies page orientation.
OutlineLevel Utility class containing constants. Specifies the outline level of a paragraph in the document.
PageBorderAppliesTo Utility class containing constants. Specifies which pages the page border is printed on.
PageBorderDistanceFrom Utility class containing constants. Specifies the positioning of the page border relative to the page margin.
PageVerticalAlignment Utility class containing constants. Specifies vertical justification of text on each page.
PaperSize Utility class containing constants. Specifies paper size.
ParagraphAlignment Utility class containing constants. Specifies text alignment in a paragraph.
ProtectionType Utility class containing constants. Protection type for a document.
RelativeHorizontalPosition Utility class containing constants. Specifies to what the horizontal position of a shape or text frame is relative.
RelativeVerticalPosition Utility class containing constants. Specifies to what the vertical position of a shape or text frame is relative.
RevisionType Utility class containing constants. Specifies the type of change being tracked in Revision.
SaveFormat Utility class containing constants. Indicates the format in which the document is saved.
SectionLayoutMode Utility class containing constants. Specifies the layout mode for a section allowing to define the document grid behavior.
SectionStart Utility class containing constants. The type of break at the beginning of the section.
ShapeLineStyle Utility class containing constants. Specifies the compound line style of a Shape.
ShapeMarkupLanguage Utility class containing constants. Specifies Markup language used for the shape.
ShapeType Utility class containing constants. Specifies the type of shape in a Microsoft Word document.
StoryType Utility class containing constants. Text of a Word document is stored in stories. StoryType identifies a story.
StyleIdentifier Utility class containing constants. Locale independent style identifier.
StyleType Utility class containing constants. Represents type of the style.
TabAlignment Utility class containing constants. Specifies the alignment/type of a tab stop.
TabLeader Utility class containing constants. Specifies the type of the leader line displayed under the tab character.
TextBoxWrapMode Utility class containing constants. Specifies how text wraps inside a shape.
TextEffect Utility class containing constants. Animation effect for text runs.
TextOrientation Utility class containing constants. Specifies orientation of text on a page, in a table cell or a text frame.
TextPathAlignment Utility class containing constants. WordArt alignment.
TextureIndex Utility class containing constants. Specifies shading texture.
Underline Utility class containing constants. Indicates type of the underline applied to a font.
VerticalAlignment Utility class containing constants. Specifies vertical alignment of a floating shape, text frame or a floating table.
VisitorAction Utility class containing constants. Allows the visitor to control the enumeration of nodes.
WarningSource Utility class containing constants. Specifies the module that produces a warning during document loading or saving.
WarningType Utility class containing constants. Specifies the type of a warning that is issued by Aspose.Words during document loading or saving.
WrapSide Utility class containing constants. Specifies what side(s) of the shape or picture the text wraps around.
WrapType Utility class containing constants. Specifies how text is wrapped around a shape or picture.
 

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.